├── .gitignore ├── images ├── mat.png ├── sin.png ├── e389a.png └── implicit_plot3d_example.png ├── Cask ├── Makefile ├── .travis.yml ├── example.org ├── tests └── tests.el ├── emacs_ob_sagemath.py ├── README.org ├── ob-sagemath.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .cask 2 | *.elc 3 | *.pyc 4 | /sample.html 5 | /README.html 6 | -------------------------------------------------------------------------------- /images/mat.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sagemath/ob-sagemath/master/images/mat.png -------------------------------------------------------------------------------- /images/sin.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sagemath/ob-sagemath/master/images/sin.png -------------------------------------------------------------------------------- /images/e389a.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sagemath/ob-sagemath/master/images/e389a.png -------------------------------------------------------------------------------- /images/implicit_plot3d_example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sagemath/ob-sagemath/master/images/implicit_plot3d_example.png -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: emacs-lisp -*- 2 | (source gnu) 3 | (source melpa) 4 | 5 | (package-file "ob-sagemath.el") 6 | (development 7 | (depends-on "f")) 8 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMACS ?= emacs 2 | CASK ?= $(HOME)/.cask/bin/cask 3 | 4 | compile: 5 | $(CASK) exec $(EMACS) -Q -eval "(setq byte-compile-error-on-warn t)" \ 6 | -batch -f batch-byte-compile ob-sagemath.el 7 | 8 | test: clean compile 9 | $(CASK) exec $(EMACS) -Q -batch -L . -l tests/tests.el -f ert-run-tests-batch-and-exit 10 | 11 | clean: 12 | rm -f ob-sagemath.elc 13 | 14 | .PHONY: compile test clean 15 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | env: 2 | # - EMACS=emacs EVM_EMACS=emacs-24.1-bin 3 | # - EMACS=emacs EVM_EMACS=emacs-24.2-bin 4 | # - EMACS=emacs EVM_EMACS=emacs-24.3-bin 5 | - EMACS=emacs EVM_EMACS=emacs-24.4-bin 6 | - EMACS=emacs EVM_EMACS=emacs-24.5-bin 7 | before_install: 8 | # Install Emacs 9 | - sudo mkdir /usr/local/evm 10 | - sudo chown travis:travis /usr/local/evm 11 | 12 | - export PATH="$HOME/.cask/bin:$PATH" 13 | - export PATH="$HOME/.evm/bin:$PATH" 14 | 15 | - curl -fsSkL --max-time 10 --retry 10 --retry-delay 10 16 | https://raw.github.com/rejeep/evm/master/go | bash 17 | - export PATH="$HOME/.evm/bin:$PATH" 18 | - evm install "$EVM_EMACS" --use --skip 19 | 20 | # Install Cask 21 | - curl -fsSkL --max-time 10 --retry 10 --retry-delay 10 22 | https://raw.github.com/cask/cask/master/go | python 23 | - export PATH="$HOME/.cask/bin:$PATH" 24 | - cask 25 | script: 26 | - emacs --version 27 | - make test 28 | -------------------------------------------------------------------------------- /example.org: -------------------------------------------------------------------------------- 1 | * Examples of code blocks 2 | ** Versions 3 | #+begin_src emacs-lisp :exports both :results output 4 | (princ "Emacs: ") 5 | (princ emacs-version) 6 | (princ "\n") 7 | (princ "Org: ") 8 | (princ (org-version)) 9 | #+end_src 10 | 11 | #+RESULTS: 12 | : Emacs: 26.0.50 13 | : Org: 9.0.5 14 | 15 | #+begin_src sage :exports both 16 | print version() 17 | #+end_src 18 | 19 | #+RESULTS: 20 | : SageMath version 8.0.beta2, Release Date: 2017-04-12 21 | 22 | ** Basic math 23 | #+begin_src sage :exports both 24 | factor(factorial(10)) 25 | #+end_src 26 | 27 | #+RESULTS: 28 | : 2^8 * 3^4 * 5^2 * 7 29 | 30 | ** Graphs 31 | #+begin_src sage :file images/sin.png :exports both 32 | P = plot(sin(x), (0, 2*pi), figsize=[5, 4]); P 33 | #+end_src 34 | 35 | #+RESULTS: 36 | [[file:images/sin.png]] 37 | 38 | 39 | This example is from the document of the method =plot= of a matrix object. 40 | #+begin_src sage :file images/mat.png :exports both 41 | m = random_matrix(RDF, 50) 42 | m.plot(figsize=5) 43 | #+end_src 44 | 45 | #+RESULTS: 46 | [[file:images/mat.png]] 47 | 48 | This example is from the document of the function =implicit_plot3d=. 49 | #+BEGIN_SRC sage :file images/implicit_plot3d_example.png :exports both 50 | var('x,y,z') 51 | T = RDF(golden_ratio) 52 | p = 2 - (cos(x + T*y) + cos(x - T*y) + cos(y + T*z) + cos(y - T*z) + cos(z - T*x) + cos(z + T*x)) 53 | r = 4.77 54 | implicit_plot3d(p, (x, -r, r), (y, -r, r), (z, -r, r), plot_points=40).show(viewer='tachyon', figsize=5) 55 | #+END_SRC 56 | 57 | #+RESULTS: 58 | [[file:images/implicit_plot3d_example.png]] 59 | 60 | 61 | 62 | ** Tables 63 | #+begin_src sage :results table :exports both 64 | [(a, factor(2^a + 1)) for a in range(5)] 65 | #+end_src 66 | 67 | #+RESULTS: 68 | | 0 | 2 | 69 | | 1 | 3 | 70 | | 2 | 5 | 71 | | 3 | 3^2 | 72 | | 4 | 17 | 73 | 74 | #+begin_src sage :results table :exports both :colnames yes 75 | colnames = ("a", "Smallest prime greater than 2^a") 76 | [colnames] + [(a, next_prime(2^a)) for a in range(50, 55)] 77 | #+end_src 78 | 79 | #+RESULTS: 80 | | a | Smallest prime greater than 2^a | 81 | |----+---------------------------------| 82 | | 50 | 1125899906842679 | 83 | | 51 | 2251799813685269 | 84 | | 52 | 4503599627370517 | 85 | | 53 | 9007199254740997 | 86 | | 54 | 18014398509482143 | 87 | 88 | You can also pass the header argument =:colnames= (an elisp) list to specify the column names. 89 | #+begin_src sage :results table :exports both :colnames '("a" "Smallest prime greater than 2^a") 90 | [(a, next_prime(2^a)) for a in range(100, 105)] 91 | #+end_src 92 | 93 | #+RESULTS: 94 | | a | Smallest prime greater than 2^a | 95 | |-----+----------------------------------| 96 | | 100 | 1267650600228229401496703205653 | 97 | | 101 | 2535301200456458802993406410833 | 98 | | 102 | 5070602400912917605986812821771 | 99 | | 103 | 10141204801825835211973625643089 | 100 | | 104 | 20282409603651670423947251286127 | 101 | 102 | 103 | ** Elliptic curve 104 | #+begin_src sage :exports both 105 | E = EllipticCurve(u'389a'); E 106 | #+end_src 107 | 108 | #+RESULTS: 109 | : Elliptic Curve defined by y^2 + y = x^3 + x^2 - 2*x over Rational Field 110 | 111 | #+begin_src sage :exports both 112 | print "Rank", E.rank() 113 | E.integral_points() 114 | #+end_src 115 | 116 | #+RESULTS: 117 | #+begin_example 118 | Rank 2 119 | 120 | [(-2 : 0 : 1), 121 | (-1 : 1 : 1), 122 | (0 : 0 : 1), 123 | (1 : 0 : 1), 124 | (3 : 5 : 1), 125 | (4 : 8 : 1), 126 | (6 : 15 : 1), 127 | (39 : 246 : 1), 128 | (133 : 1539 : 1), 129 | (188 : 2584 : 1)] 130 | #+end_example 131 | 132 | #+begin_src sage :file images/e389a.png :exports both 133 | E.plot(figsize=5) 134 | #+end_src 135 | 136 | #+RESULTS: 137 | [[file:images/e389a.png]] 138 | -------------------------------------------------------------------------------- /tests/tests.el: -------------------------------------------------------------------------------- 1 | (require 'f) 2 | (require 'ert) 3 | (require 'ob-sagemath) 4 | 5 | (setq ob-sagemath-output-display-function #'ignore) 6 | 7 | (setq org-babel-default-header-args:sage '((:session . t) 8 | (:results . "output") 9 | (:latexnewline . "\\\\\n") 10 | (:latexwrap . ("\\(" . "\\)")))) 11 | 12 | (defun ob-sagemath-test-exec (params body) 13 | (org-babel-execute:sage 14 | body 15 | (append params org-babel-default-header-args:sage))) 16 | 17 | (when (executable-find "sage") 18 | 19 | (ert-deftest ob-sagemth-latex-code-block () 20 | (should (string= (ob-sagemath-test-exec 21 | '((:tolatex . "yes") 22 | (:latexwrap . nil)) 23 | "sqrt(x)") 24 | "\\sqrt{x}")) 25 | (should (string= (ob-sagemath-test-exec 26 | nil 27 | "show(sqrt(x))") 28 | "\\(\\sqrt{x}\\)")) 29 | (should (string= (ob-sagemath-test-exec 30 | '((:tolatex . "yes") 31 | (:latexwrap . ("\\begin{gather*}\n" . "\n\\end{gather*}"))) 32 | "sqrt(x)\nsqrt(x)") 33 | "\\begin{gather*} 34 | \\sqrt{x}\\\\ 35 | \\sqrt{x} 36 | \\end{gather*}"))) 37 | 38 | (ert-deftest ob-sagemath-results-value () 39 | (should (string= (ob-sagemath-test-exec 40 | '((:result-params "value")) 41 | "print 1\n2") 42 | "2"))) 43 | 44 | (ert-deftest ob-sagemath-image () 45 | (let ((file (make-temp-file "ob-sage" nil ".png"))) 46 | (should (null (ob-sagemath-test-exec 47 | `((:file . ,file)) 48 | "plot(sin, (0, 2*pi))"))) 49 | (should 50 | (> (f-size file) 0)) 51 | (delete-file file)) 52 | (let ((file (ob-sagemath-test-exec 53 | '((:result-params "file")) 54 | "plot(sin, (0, 2*pi))"))) 55 | (should (stringp file)) 56 | (should (f-exists? file)) 57 | (should (> (f-size file) 0)))) 58 | 59 | (ert-deftest ob-sagemath-table () 60 | (let ((l '(("0" "2") ("1" "3") ("2" "5") ("3" "3^2") ("4" "17")))) 61 | (should (equal (ob-sagemath-test-exec 62 | '((:result-params "table")) 63 | "[(a, factor(2^a + 1)) for a in range(5)]") 64 | l)) 65 | (should (equal (ob-sagemath-test-exec 66 | '((:result-params "table") 67 | (:colnames "foo" "bar")) 68 | "[(a, factor(2^a + 1)) for a in range(5)]") 69 | `(("foo" "bar") hline ,@l))))) 70 | 71 | (ert-deftest ob-sagemath-misc () 72 | (should (string= (ob-sagemath-test-exec 73 | nil 74 | "factor(factorial(10))") 75 | "2^8 * 3^4 * 5^2 * 7")))) 76 | 77 | (ert-deftest ob-sagemath-table-or-string () 78 | (should (equal (ob-sagemath-table-or-string 79 | "[[[1, 2, 3], 'a'], ('[[a, b]], c', d), [[4, 5, 6], c]]" nil) 80 | '(("[1, 2, 3]" "a") ("[[a, b]], c" "d") ("[4, 5, 6]" "c"))))) 81 | 82 | (ert-deftest ob-sagemath--latex-arg-test () 83 | (should (string= (ob-sagemath--latex-arg '(())) "False")) 84 | (should (string= (ob-sagemath--latex-arg '((:tolatex))) "True")) 85 | (should (string= (ob-sagemath--latex-arg '((:tolatex . "yes"))) "True")) 86 | (should (string= (ob-sagemath--latex-arg '((:tolatex . "no"))) "False")) 87 | (should (string= (ob-sagemath--latex-arg '((:tolatex . "foo.bar"))) "True"))) 88 | 89 | (ert-deftest ob-sagemath--escape-code-test () 90 | (should (string= (ob-sagemath--escape-code "print 'foobar\\nbar\\nbaz' 91 | print \"foo\\nbar\" 92 | print r\"\\bar\" 93 | print r'\\foo\\n\\bar'") 94 | "print 'foobar\\\\nbar\\\\nbaz'\\nprint \\\"foo\\\\nbar\\\"\\nprint r\\\"\\\\bar\\\"\\nprint r'\\\\foo\\\\n\\\\bar'"))) 95 | -------------------------------------------------------------------------------- /emacs_ob_sagemath.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8; mode: sage -*- 2 | from __future__ import print_function 3 | 4 | import sage.misc.latex 5 | from emacs_sage_shell import read_file_and_run_cell as ss_read_file_and_run_cell 6 | from emacs_sage_shell import ip 7 | from sage.repl.rich_output import get_display_manager 8 | from sage.repl.rich_output.backend_ipython import BackendIPythonCommandline 9 | from sage.repl.rich_output.output_basic import OutputLatex 10 | from sage.repl.rich_output.output_catalog import OutputImagePng 11 | from sage.repl.rich_output.preferences import DisplayPreferences 12 | 13 | 14 | class LastState(object): 15 | 16 | def __init__(self): 17 | # Used for image files 18 | self.filename = None 19 | self.result = None 20 | self.latex = None 21 | self.latex_formatter = None 22 | 23 | last_state = LastState() 24 | 25 | 26 | class BackendEmacsBabel(BackendIPythonCommandline): 27 | 28 | def __init__(self, state): 29 | super(BackendEmacsBabel, self).__init__() 30 | self.__state = state 31 | 32 | @property 33 | def state(self): 34 | return self.__state 35 | 36 | def default_preferences(self): 37 | if self.state.latex: 38 | text = 'latex' 39 | else: 40 | text = None 41 | return DisplayPreferences(text=text) 42 | 43 | def latex_formatter(self, obj, **kwargs): 44 | last_state.latex = True 45 | if self.state.latex_formatter is not None and callable(self.state.latex_formatter): 46 | return OutputLatex(self.state.latex_formatter(obj)) 47 | if 'concatenate' in kwargs: 48 | combine_all = kwargs['combine_all'] 49 | else: 50 | combine_all = False 51 | return OutputLatex(sage.misc.latex.latex(obj, combine_all=combine_all)) 52 | 53 | def _repr_(self): 54 | return "Emacs babel" 55 | 56 | def displayhook(self, plain_text, rich_output): 57 | if isinstance(rich_output, OutputImagePng): 58 | msg = rich_output.png.filename(ext='png') 59 | babel_filename = self.state.filename 60 | if babel_filename is not None: 61 | rich_output.png.save_as(babel_filename) 62 | msg = babel_filename 63 | return ({u'text/plain': msg}, {}) 64 | else: 65 | return super(BackendEmacsBabel, self).displayhook(plain_text, rich_output) 66 | 67 | 68 | gdm = get_display_manager() 69 | 70 | 71 | def run_cell_babel_base(run_cell_func, 72 | filename=None, latex=None, latex_formatter=None): 73 | last_state.filename = filename 74 | last_state.result = None 75 | last_state.latex = latex 76 | last_state.latex_formatter = latex_formatter 77 | 78 | backend_ob_sage = BackendEmacsBabel(last_state) 79 | with sagebackend(backend_ob_sage): 80 | res = run_cell_func() 81 | if res.success: 82 | last_state.result = res.result 83 | print(0) 84 | else: 85 | print(1) 86 | 87 | 88 | def read_file_and_run_cell(tmp_file, **kwargs): 89 | def run_cel_func(): 90 | return ss_read_file_and_run_cell(tmp_file) 91 | run_cell_babel_base(run_cel_func, **kwargs) 92 | 93 | 94 | class WithBackEnd(object): 95 | 96 | def __init__(self, back_end): 97 | self.__back_end = back_end 98 | self.__prv = None 99 | 100 | def __enter__(self): 101 | self.__prv = gdm.switch_backend(self.__back_end, shell=ip) 102 | 103 | def __exit__(self, err_type, value, traceback): 104 | gdm.switch_backend(self.__prv, shell=ip) 105 | 106 | 107 | def sagebackend(back_end): 108 | return WithBackEnd(back_end) 109 | 110 | 111 | def print_last_result(module_name): 112 | backend_ob_sage = BackendEmacsBabel(last_state) 113 | with sagebackend(backend_ob_sage): 114 | ip.run_cell("%s.last_state.result" % module_name) 115 | 116 | 117 | def print_last_latex(): 118 | print(last_state.latex) 119 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * ob-sagemath 2 | [[http://melpa.org/#/ob-sagemath][file:http://melpa.org/packages/ob-sagemath-badge.svg]] 3 | [[http://stable.melpa.org/#/ob-sagemath][file:http://stable.melpa.org/packages/ob-sagemath-badge.svg]] 4 | [[https://travis-ci.org/stakemori/ob-sagemath][https://travis-ci.org/stakemori/ob-sagemath.svg]] 5 | 6 | ob-sagemath provides an [[http://orgmode.org/worg/org-contrib/babel/][org-babel]] integration with [[http://www.sagemath.org/][SageMath]] by [[https://github.com/stakemori/sage-shell-mode][sage-shell-mode]]. 7 | This package is inspired by [[https://github.com/gregsexton/ob-ipython][ob-ipython]], 8 | though the implementation is completely different. 9 | 10 | ** Requirements 11 | 1. SageMath 6.6 or newer. 12 | 1. GNU Emacs 24.3 or newer. 13 | 1. [[https://github.com/stakemori/sage-shell-mode][sage-shell-mode]] 14 | 15 | ** Installation and sample configuration 16 | You can install =ob-sagemath= from [[https://github.com/milkypostman/melpa.git][MELPA]]. 17 | =ob-sagemath= requires [[https://github.com/stakemori/sage-shell-mode][sage-shell-mode]]. 18 | See [[https://github.com/stakemori/sage-shell-mode#installation-and-setup][Installation and Setup]] to setup [[https://github.com/stakemori/sage-shell-mode][sage-shell-mode]]. 19 | The following is a sample configuration for =ob-sagemath=. Put these lines in your "~/.emacs.d/init.el". 20 | 21 | #+begin_src emacs-lisp 22 | ;; Ob-sagemath supports only evaluating with a session. 23 | (setq org-babel-default-header-args:sage '((:session . t) 24 | (:results . "output"))) 25 | 26 | ;; C-c c for asynchronous evaluating (only for SageMath code blocks). 27 | (with-eval-after-load "org" 28 | (define-key org-mode-map (kbd "C-c c") 'ob-sagemath-execute-async)) 29 | 30 | ;; Do not confirm before evaluation 31 | (setq org-confirm-babel-evaluate nil) 32 | 33 | ;; Do not evaluate code blocks when exporting. 34 | (setq org-export-babel-evaluate nil) 35 | 36 | ;; Show images when opening a file. 37 | (setq org-startup-with-inline-images t) 38 | 39 | ;; Show images after evaluating code blocks. 40 | (add-hook 'org-babel-after-execute-hook 'org-display-inline-images) 41 | #+end_src 42 | 43 | ** Example file 44 | Here is an example org file. 45 | 46 | [[file:./example.org][example.org]] 47 | 48 | ** Session 49 | ob-sagemath currently supports only evaluating with a session by using [[https://github.com/stakemori/sage-shell-mode][sage-shell-mode]]. 50 | So like in the sample configuration, you have to provide the =:session= header argument. 51 | Usually, code blocks are evaluated in the =*Sage*= process buffer. 52 | If the =:session= argument is provided and it is a string, then the code block is evaluated in 53 | another process buffer. 54 | For example, by evaluating the following code block, a process buffer =*Sage*= is created and 55 | the code block is evaluated in the process buffer. 56 | 57 | #+BEGIN_EXAMPLE 58 | ,#+BEGIN_SRC sage :session foo 59 | print 'This code will be evaluated in the process buffer *Sage*.' 60 | ,#+END_SRC 61 | #+END_EXAMPLE 62 | 63 | ** Asynchronous evaluation 64 | You can evaluate SageMath code blocks by =C-c C-c= (bound to =org-ctrl-c-ctrl-c=) like in other org-babel packages. 65 | But usually it blocks user inputs. In the sample configuration, =C-c c= is bound to =ob-sagemath-execute-async=. 66 | And it enables the asynchronous evaluation. So you can interact with Emacs during the evaluation. 67 | With a prefix argument, it evaluates all code blocks in a buffer. 68 | If the =org-mode= buffer is killed during the evaluation, the output will be lost. 69 | Please do not kill the =org-mode= buffer until the evaluation completes. 70 | 71 | Because =org-mode= doesn't provide a standard way for asynchronous evaluation, 72 | *this feature is unstable.* 73 | 74 | 75 | ** Images 76 | Image files of graphs can be embedded by providing the =:file= header argument. 77 | By evaluating the code block, the image file is stored in the file. 78 | Here is an example. 79 | 80 | #+BEGIN_EXAMPLE 81 | ,#+BEGIN_SRC sage :file sin.png 82 | # You can change the size of the image by providing the figsize argument. 83 | plot(sin, [0, 2*pi], figsize=4) 84 | ,#+END_SRC 85 | 86 | ,#+RESULTS: 87 | [[file:sin.png]] 88 | #+END_EXAMPLE 89 | 90 | If the =:file= header argument is not provided and the =:results= header argument contains =file=, 91 | then the code block returns a temporally file name. 92 | SageMath deletes these temporally files when the process exits. 93 | 94 | #+BEGIN_EXAMPLE 95 | ,#+BEGIN_SRC sage :results file 96 | plot(sin, [0, 2*pi]) 97 | ,#+END_SRC 98 | #+END_EXAMPLE 99 | 100 | 101 | ** Tables 102 | If the =:results= header argument contains =table= and the output looks like a table 103 | (a list/tuple of lists/tuples), then the result is converted to a table. 104 | 105 | #+BEGIN_EXAMPLE 106 | ,#+BEGIN_SRC sage :results table :colnames '(Fruit Price) 107 | [("Apple", 300), ("Banana", 200), ("Orange", 300)] 108 | ,#+END_SRC 109 | 110 | ,#+RESULTS: 111 | | Fruit | Price | 112 | |--------+-------| 113 | | Apple | 300 | 114 | | Banana | 200 | 115 | | Orange | 300 | 116 | #+END_EXAMPLE 117 | 118 | ** Kill evaluation 119 | To kill the evaluation, switch to the process buffer (usually its buffer name is =*Sage*=), 120 | and hit =C-c C-c= (bound to =sage-shell:interrupt-subjob=). 121 | 122 | ** Issues or pull requests 123 | I am new to org-babel. There may be missing features. Feel free to post issues or send pull requests. 124 | -------------------------------------------------------------------------------- /ob-sagemath.el: -------------------------------------------------------------------------------- 1 | ;;; ob-sagemath.el --- org-babel functions for SageMath evaluation -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2016 - 2017 Sho Takemori. 4 | 5 | ;; Author: Sho Takemori 6 | ;; URL: https://github.com/stakemori/ob-sagemath 7 | ;; Package-Requires: ((sage-shell-mode "0.0.8") (s "1.8.0") (emacs "24")) 8 | ;; Version: 0.4 9 | ;; Keywords: SageMath, org-babel 10 | 11 | ;;; License: 12 | ;; This program is free software; you can redistribute it and/or modify 13 | ;; it under the terms of the GNU General Public License as published by 14 | ;; the Free Software Foundation; either version 3, or (at your option) 15 | ;; any later version. 16 | ;; 17 | ;; This program is distributed in the hope that it will be useful, 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | ;; GNU General Public License for more details. 21 | ;; 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the 24 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 25 | ;; Boston, MA 02110-1301, USA. 26 | 27 | ;;; Commentary: 28 | 29 | ;; org-babel integration with SageMath using sage-shell-mode. Visit 30 | ;; https://github.com/stakemori/ob-sagemath for more information. 31 | 32 | 33 | ;;; Code: 34 | (require 'org) 35 | (require 'sage-shell-mode) 36 | (require 'ob-python) 37 | (require 's) 38 | (add-to-list 'org-babel-tangle-lang-exts '("sage" . "sage")) 39 | (add-to-list 'org-src-lang-modes '("sage" . sage-shell:sage)) 40 | 41 | (defgroup ob-sagemath 42 | nil "Group for ob-sagemath" 43 | :group 'org-babel) 44 | 45 | (defcustom ob-sagemath-output-display-function #'display-buffer 46 | "Function for displaying buffer for the standard output when using :results value" 47 | :group 'ob-sagemath 48 | :type 'function) 49 | 50 | (defvar org-babel-header-args:sage 51 | '((tolatex . :any) 52 | (latexwrap . :any) 53 | (latexnewline . :any)) 54 | "SageMath specific header arguments") 55 | 56 | (defvar ob-sagemath--python-script-dir 57 | (if load-file-name 58 | (file-name-directory load-file-name) 59 | default-directory)) 60 | 61 | (defvar ob-sagemath--script-name "_emacs_ob_sagemath") 62 | 63 | (defvar ob-sagemath--imported-p nil) 64 | (make-variable-buffer-local 'ob-sagemath--imported-p) 65 | 66 | (defun ob-sagemath--python-name (f) 67 | (format "%s.%s" ob-sagemath--script-name f)) 68 | 69 | (defun ob-sagemath--import-script () 70 | "Assumes `sage-shell:process-buffer' is already set." 71 | (sage-shell:with-current-buffer-safe sage-shell:process-buffer 72 | (unless ob-sagemath--imported-p 73 | (sage-shell:send-command 74 | (s-join "; " 75 | (list 76 | (format "sys.path.append('%s')" 77 | ob-sagemath--python-script-dir) 78 | (format "import emacs_ob_sagemath as %s" 79 | ob-sagemath--script-name))) 80 | nil nil t) 81 | (setq ob-sagemath--imported-p t)))) 82 | 83 | (defun ob-sagemath--cache-current-p (info params) 84 | (let ((cache (cdr (assoc :cache params)))) 85 | (when (and cache (string= "yes" cache)) 86 | (let ((new-hash (org-babel-sha1-hash info))) 87 | (and new-hash 88 | (equal new-hash (org-babel-current-result-hash))))))) 89 | 90 | (defvar ob-sagemath--last-success-state t) 91 | (cl-defstruct ob-sagemath--res-info 92 | result success output) 93 | 94 | (defun ob-sagemath--last-res-info (output params) 95 | (let* ((res-params (assoc-default :result-params params)) 96 | (suc-str (substring-no-properties output -2 -1)) 97 | ;; Remove success state and the final new line 98 | (out-str (substring-no-properties output 0 -2)) 99 | (success (setq ob-sagemath--last-success-state 100 | (cond ((string= suc-str "0") 101 | t) 102 | ((string= suc-str "1") 103 | nil) 104 | (t (error "Invalid output:\n%s" output)))))) 105 | (let ((res (if (member "value" res-params) 106 | (sage-shell:send-command-to-string 107 | (format "%s('%s')" 108 | (ob-sagemath--python-name "print_last_result") 109 | ob-sagemath--script-name)) 110 | out-str))) 111 | (unless (s-blank? res) 112 | (setq res (substring res 0 -1))) 113 | (when success 114 | (setq res (ob-sagemath--latex-filter res params))) 115 | (cond ((member "value" res-params) 116 | (make-ob-sagemath--res-info 117 | :success success 118 | :output out-str 119 | :result res)) 120 | (t (make-ob-sagemath--res-info 121 | :success success 122 | :result res)))))) 123 | 124 | 125 | (defun ob-sagemath--latex-filter (s params) 126 | (when (or (assoc :tolatex params) 127 | (string= 128 | (s-trim (sage-shell:send-command-to-string 129 | (ob-sagemath--python-name "print_last_latex()"))) 130 | "True")) 131 | (let ((newline (assoc-default :latexnewline params))) 132 | (when newline 133 | (setq s (s-replace "\n" newline s)))) 134 | (let ((wrap (assoc-default :latexwrap params))) 135 | (when (and wrap (consp wrap)) 136 | (setq s (format "%s%s%s" (car wrap) s (cdr wrap)))))) 137 | s) 138 | 139 | ;;;###autoload 140 | (defun ob-sagemath-execute-async (arg) 141 | "Execute current src code block. With prefix argument, evaluate all code in a 142 | buffer." 143 | (interactive "p") 144 | (cl-case arg 145 | (1 (ob-sagemath-execute-async-1)) 146 | (4 (ob-sagemath-execute-buffer-async)))) 147 | 148 | (defun ob-sagemath-execute-async-1 () 149 | (let* ((org-element--cache nil) ; Avoid using cache. 150 | (info (org-babel-get-src-block-info)) 151 | (language (car info)) 152 | (body (nth 1 info)) 153 | (params (nth 2 info))) 154 | (cond ((and language body 155 | ;; To avoid byte-compiler warning 156 | ;; with-no-warnings doesn't work in Emacs 25.1 157 | (null org-element--cache) 158 | 159 | (ob-sagemath--cache-current-p info params)) 160 | ;; If result is cached, call sync version. 161 | (org-babel-execute-src-block nil info params)) 162 | ((member language '("sage" "sage-shell")) 163 | (ob-sagemath--execute1 body params)) 164 | (t (call-interactively #'org-ctrl-c-ctrl-c))))) 165 | 166 | (defun ob-sagemath--init (session sync) 167 | (unless (and (sage-shell:sage-executable) 168 | (executable-find (sage-shell:sage-executable))) 169 | (error sage-shell:exec-path-error-msg)) 170 | (let ((cmd (sage-shell:sage-executable))) 171 | (cond ((string= session "none") 172 | (error 173 | (concat 174 | "ob-sagemath currently only supports evaluation using a session." 175 | " Make sure your src block has a :session param."))) 176 | ((stringp session) 177 | (setq sage-shell:process-buffer 178 | (sage-shell:run cmd nil 179 | :switch-function 'no-switch 180 | :buffer-name (format "*Sage<%s>*" session)))) 181 | (t (setq sage-shell:process-buffer 182 | (sage-shell:run cmd nil 183 | :switch-function 'no-switch))))) 184 | 185 | (unless sync 186 | (org-babel-remove-result) 187 | (message "Evaluating code block ..."))) 188 | 189 | (defun ob-sagemath--execute1 (body params) 190 | (let* ((pt (point)) 191 | (buf (current-buffer)) 192 | (marker (make-marker)) 193 | (marker (set-marker marker pt))) 194 | (ob-sagemath--eval 195 | body params 196 | :callback (lambda (res-info) 197 | (ob-sagemath--define-exec-sage-async 198 | res-info params buf marker))))) 199 | 200 | (defun ob-sagemath--define-exec-sage-async (res-info params buf marker) 201 | (unwind-protect 202 | (progn 203 | (defun org-babel-execute:sage (_body _params) 204 | (ob-sagemath--res-info-to-result res-info params)) 205 | (with-current-buffer buf 206 | (save-excursion 207 | (goto-char marker) 208 | (call-interactively #'org-babel-execute-src-block) 209 | (ob-sagemath--exec-callback res-info params)))) 210 | (fset 'org-babel-execute:sage #'ob-sagemath--execute-sync))) 211 | 212 | (defun ob-sagemath--exec-callback (res-info params) 213 | (let ((success-p (ob-sagemath--res-info-success res-info)) 214 | (result (ob-sagemath--res-info-result res-info)) 215 | (output (ob-sagemath--res-info-output res-info))) 216 | (unless success-p 217 | (ob-sagemath--failure-callback 218 | (cond ((member "value" (assoc-default :result-params params)) 219 | output) 220 | (t result)))) 221 | (when (and output (not (string= output ""))) 222 | (funcall 223 | ob-sagemath-output-display-function 224 | (ob-sagemath--make-output-buffer output))))) 225 | 226 | (defun ob-sagemath--res-info-to-result (res-info params) 227 | (let ((success-p (ob-sagemath--res-info-success res-info)) 228 | (result (ob-sagemath--res-info-result res-info)) 229 | (res-params (assoc-default :result-params params))) 230 | (cond (success-p 231 | (cond ((assq :file params) nil) 232 | ((member "file" res-params) 233 | (s-trim result)) 234 | ((member "table" res-params) 235 | (ob-sagemath-table-or-string (s-trim result) params)) 236 | (t result))) 237 | ;; Return the empty string when it fails. 238 | (t "")))) 239 | 240 | (defun ob-sagemath--execute-sync (body params) 241 | (ob-sagemath--eval 242 | body params 243 | :sync t 244 | :callback (lambda (res-info) 245 | (prog1 246 | (ob-sagemath--res-info-to-result res-info params) 247 | (ob-sagemath--exec-callback res-info params))))) 248 | ;;;###autoload 249 | (defun org-babel-execute:sage (body params) 250 | (ob-sagemath--execute-sync body params)) 251 | 252 | (cl-defun ob-sagemath--eval (body params &key sync callback) 253 | "CALLBACK will be called when evaluation is done with argument RES-INFO." 254 | (let ((session (cdr (assoc :session params))) 255 | (raw-code (org-babel-expand-body:generic 256 | (encode-coding-string body 'utf-8) 257 | params (org-babel-variable-assignments:python params))) 258 | (buf (current-buffer)) 259 | (coding-system-for-write 'utf-8)) 260 | 261 | (ob-sagemath--init session sync) 262 | 263 | (when sync 264 | (while (not (sage-shell:output-finished-p)) 265 | (accept-process-output 266 | (get-buffer-process sage-shell:process-buffer) 0.3) 267 | (sleep-for 0.3))) 268 | 269 | (with-current-buffer sage-shell:process-buffer 270 | (cond 271 | (sync (ob-sagemath--import-script) 272 | (let* ((raw-output (sage-shell:send-command-to-string 273 | (ob-sagemath--code raw-code params buf))) 274 | (res-info (ob-sagemath--last-res-info raw-output params))) 275 | (sage-shell:clear-command-cache) 276 | (funcall callback res-info))) 277 | (t (sage-shell:after-output-finished 278 | ;; Import a Python script if necessary. 279 | (ob-sagemath--import-script) 280 | 281 | (sage-shell:change-mode-line-process t "eval") 282 | (sage-shell:run-cell-raw-output 283 | (ob-sagemath--code raw-code params buf) 284 | :callback (lambda (raw-output) 285 | (condition-case err-var 286 | (progn 287 | (sage-shell:change-mode-line-process nil) 288 | (sage-shell:clear-command-cache) 289 | (funcall callback 290 | (ob-sagemath--last-res-info raw-output params))) 291 | 292 | (error 293 | (sage-shell:change-mode-line-process nil) 294 | (signal (car err-var) 295 | (cdr err-var)))))))))))) 296 | 297 | 298 | (defvar ob-sagemath-output-buffer-name "*Ob-SageMath-Output*") 299 | (defun ob-sagemath--make-output-buffer (output) 300 | (let ((inhibit-read-only t) 301 | (view-read-only nil) 302 | (buf (get-buffer-create ob-sagemath-output-buffer-name))) 303 | (with-current-buffer buf 304 | (erase-buffer) 305 | (insert output) 306 | (view-mode 1)) 307 | ;; Return the buffer 308 | buf)) 309 | 310 | (defvar ob-sagemath-error-buffer-name "*Ob-SageMath-Error*") 311 | (defvar ob-sagemath--error-regexp 312 | (rx symbol-start 313 | (or "ArithmeticError" "AssertionError" "AttributeError" 314 | "BaseException" "BufferError" "BytesWarning" "DeprecationWarning" 315 | "EOFError" "EnvironmentError" "Exception" "FloatingPointError" 316 | "FutureWarning" "GeneratorExit" "IOError" "ImportError" 317 | "ImportWarning" "IndentationError" "IndexError" "KeyError" 318 | "KeyboardInterrupt" "LookupError" "MemoryError" "NameError" 319 | "NotImplementedError" "OSError" "OverflowError" 320 | "PendingDeprecationWarning" "ReferenceError" "RuntimeError" 321 | "RuntimeWarning" "StandardError" "StopIteration" "SyntaxError" 322 | "SyntaxWarning" "SystemError" "SystemExit" "TabError" "TypeError" 323 | "UnboundLocalError" "UnicodeDecodeError" "UnicodeEncodeError" 324 | "UnicodeError" "UnicodeTranslateError" "UnicodeWarning" 325 | "UserWarning" "ValueError" "Warning" "ZeroDivisionError") 326 | symbol-end)) 327 | 328 | (defvar ob-sagemath--error-syntax-table 329 | (let ((table (make-syntax-table))) 330 | (modify-syntax-entry ?\" "w" table) 331 | (modify-syntax-entry ?\' "w" table) 332 | table)) 333 | 334 | (define-derived-mode ob-sagemath-error-mode nil "ObSageMathError" 335 | "Major mode for display errors." 336 | (set-syntax-table ob-sagemath--error-syntax-table) 337 | (setq font-lock-defaults 338 | (list (list (cons ob-sagemath--error-regexp 'font-lock-warning-face)) 339 | nil nil nil 'beginning-of-line))) 340 | 341 | (defun ob-sagemath--failure-callback (output) 342 | (let ((inhibit-read-only t) 343 | (view-read-only nil) 344 | (buf (get-buffer-create ob-sagemath-error-buffer-name))) 345 | (with-current-buffer buf 346 | (erase-buffer) 347 | (insert output) 348 | (ob-sagemath-error-mode) 349 | (unless view-mode (view-mode))) 350 | (pop-to-buffer buf) 351 | (message "An error raised in the SageMath process."))) 352 | 353 | 354 | (defun ob-sagemath--escape-code (raw-code) 355 | (setq raw-code (replace-regexp-in-string (rx "\\") "\\\\" raw-code nil t) 356 | raw-code (replace-regexp-in-string (rx "\"") "\\\"" raw-code nil t)) 357 | (replace-regexp-in-string (rx "\n") "\\n" raw-code nil t)) 358 | 359 | (defun ob-sagemath--code (raw-code params buf) 360 | "Return code for evaluatation." 361 | (let ((tmp-file (sage-shell-edit:temp-file "sage"))) 362 | (with-temp-buffer 363 | (insert raw-code) 364 | (sage-shell-edit:write-region-to-file 365 | (point-min) 366 | (point-max) 367 | tmp-file)) 368 | (format "%s(\"%s\", filename=%s, latex=%s, latex_formatter=%s)" 369 | (ob-sagemath--python-name "read_file_and_run_cell") 370 | tmp-file 371 | (ob-sagemath--result-file-name params buf) 372 | (ob-sagemath--latex-arg params) 373 | (ob-sagemath--latex-fmttr params)))) 374 | 375 | (defun ob-sagemath--latex-arg (params) 376 | (let* ((tolatex-cons (assoc :tolatex params)) 377 | (tolatex (cdr tolatex-cons))) 378 | (cond 379 | ((or (null tolatex-cons) 380 | (and tolatex-cons 381 | (string= tolatex "no"))) 382 | "False") 383 | (t "True")))) 384 | 385 | (defun ob-sagemath--latex-fmttr (params) 386 | (let ((tolatex (assoc-default :tolatex params))) 387 | (cond 388 | ((or (string= tolatex "yes") 389 | (string= tolatex "no")) "None") 390 | (tolatex tolatex) 391 | (t "None")))) 392 | 393 | (defun ob-sagemath--result-file-name (params buf) 394 | "Return png file name." 395 | (sage-shell:aif (assoc-default :file params) 396 | (format "\"%s\"" 397 | (with-current-buffer buf 398 | (expand-file-name it default-directory))) 399 | "None")) 400 | 401 | (defsubst ob-sagemath--table-dpt-lv () 402 | "Return depth in parens when the point is not in string" 403 | (let ((ppss (syntax-ppss))) 404 | (and (not (nth 3 ppss)) 405 | (car ppss)))) 406 | 407 | (defun ob-sagemath-table-or-string (res params) 408 | (with-temp-buffer 409 | (insert res) 410 | (goto-char (point-min)) 411 | (cond ((and (looking-at (rx (or "((" "([" "[(" "[["))) 412 | ;; When res is not a list of lists/tuples return res 413 | (save-excursion 414 | (and (ignore-errors (forward-list 1)) 415 | (string-match-p 416 | (rx bol (0+ whitespace) eol) 417 | (buffer-substring-no-properties (point) (point-max)))))) 418 | (forward-char 1) 419 | (let ((res (with-syntax-table sage-shell-mode-syntax-table 420 | (cl-loop while (re-search-forward 421 | (rx (or "(" "[")) nil t) 422 | when (save-excursion 423 | (forward-char -1) 424 | (equal (ob-sagemath--table-dpt-lv) 425 | 1)) 426 | collect 427 | (ob-sagemath-table-or-string--1 428 | (point) 429 | (progn (forward-char -1) 430 | (forward-list) (1- (point)))))))) 431 | (let ((colnames (cdr (assoc :colnames params)))) 432 | (cond ((equal colnames "yes") 433 | (append (list (car res) 'hline) (cdr res))) 434 | ((and colnames (listp colnames)) 435 | (append (list colnames 'hline) res)) 436 | (t res))))) 437 | (t res)))) 438 | 439 | (defun ob-sagemath-table-or-string--1 (beg end) 440 | (let ((start beg)) 441 | (goto-char beg) 442 | (append 443 | (cl-loop while (re-search-forward "," end t) 444 | when (equal (ob-sagemath--table-dpt-lv) 2) 445 | collect (prog1 446 | (ob-sagemath--string-unqote 447 | (s-trim 448 | (buffer-substring-no-properties 449 | start (- (point) 1)))) 450 | (setq start (point)))) 451 | (list (ob-sagemath--string-unqote 452 | (s-trim (buffer-substring-no-properties start end))))))) 453 | 454 | (defun ob-sagemath--string-unqote (s) 455 | (sage-shell:->> 456 | (cond ((string-match (rx bol (group (or (1+ "'") (1+ "\""))) (1+ nonl)) 457 | s) 458 | (let ((ln (length (match-string 1 s)))) 459 | (substring s ln (- (length s) ln)))) 460 | (t s)) 461 | (s-replace "\\\\" "\\"))) 462 | 463 | (defun ob-sagemath--code-block-markers () 464 | (let ((markers nil) 465 | (mrkr nil)) 466 | (org-save-outline-visibility t 467 | (org-babel-map-executables nil 468 | (setq mrkr (make-marker)) 469 | (set-marker mrkr (save-excursion (forward-line 1) (point))) 470 | (push mrkr markers))) 471 | (reverse markers))) 472 | 473 | (defun ob-sagemath-execute-buffer-async () 474 | (interactive) 475 | (setq ob-sagemath--last-success-state t) 476 | (let ((markers (ob-sagemath--code-block-markers)) 477 | (buf (current-buffer))) 478 | (save-excursion 479 | (ob-sagemath--execute-markers markers buf)))) 480 | 481 | 482 | (defun ob-sagemath--execute-markers (markers buf) 483 | (cond ((null markers) 484 | (message "Every code block in this buffer has been evaluated.")) 485 | (ob-sagemath--last-success-state 486 | (with-current-buffer buf 487 | (save-excursion 488 | (goto-char (car markers)) 489 | (ob-sagemath-execute-async-1)) 490 | (cond ((and sage-shell:process-buffer 491 | (buffer-live-p sage-shell:process-buffer)) 492 | (sage-shell:after-output-finished 493 | (sage-shell:after-redirect-finished 494 | (ob-sagemath--execute-markers (cdr markers) buf)))) 495 | (t (ob-sagemath--execute-markers (cdr markers) buf))))) 496 | (t (setq ob-sagemath--last-success-state t)))) 497 | 498 | (provide 'ob-sagemath) 499 | ;;; ob-sagemath.el ends here 500 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | --------------------------------------------------------------------------------