├── .gitignore
├── .github
    └── workflows
    │   └── compile.yml
├── .dir-locals.el
├── README.org
├── Makefile
├── CHANGELOG
├── closql.el
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | /*.elc
2 | /*-autoloads.el
3 | /.config.mk
4 | 


--------------------------------------------------------------------------------
/.github/workflows/compile.yml:
--------------------------------------------------------------------------------
1 | name: Compile
2 | on: [push, pull_request]
3 | jobs:
4 |   compile:
5 |     name: Compile
6 |     uses: emacscollective/workflows/.github/workflows/compile.yml@main
7 | 


--------------------------------------------------------------------------------
/.dir-locals.el:
--------------------------------------------------------------------------------
 1 | ((nil
 2 |   (indent-tabs-mode . nil))
 3 |  (makefile-mode
 4 |   (indent-tabs-mode . t))
 5 |  (git-commit-mode
 6 |   (git-commit-major-mode . git-commit-elisp-text-mode))
 7 |  ("CHANGELOG"
 8 |   (nil
 9 |    (fill-column . 70)
10 |    (mode . display-fill-column-indicator))))
11 | 


--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
 1 | * Store EIEIO objects using EmacSQL
 2 | 
 3 | Store uniform [[https://www.gnu.org/software/emacs/manual/html_node/eieio/index.html][EIEIO]] objects in an [[https://github.com/skeeto/emacsql][EmacSQL]] database.  [[https://www.sqlite.org][SQLite]] is used
 4 | as backend.  This library imposes some restrictions on what kind of
 5 | objects can be stored; it isn't intended to store arbitrary objects.
 6 | All objects have to share a common superclass and subclasses cannot
 7 | add any additional instance slots.
 8 | 
 9 | #+html: <br><br>
10 | #+html: <a href="https://github.com/magit/closql/actions/workflows/compile.yml"><img alt="Compile" src="https://github.com/magit/closql/actions/workflows/compile.yml/badge.svg"/></a>
11 | #+html: <a href="https://stable.melpa.org/#/closql"><img alt="MELPA Stable" src="https://stable.melpa.org/packages/closql-badge.svg"/></a>
12 | #+html: <a href="https://melpa.org/#/closql"><img alt="MELPA" src="https://melpa.org/packages/closql-badge.svg"/></a>
13 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | -include .config.mk
 2 | 
 3 | PKG = closql
 4 | 
 5 | ELS   = $(PKG).el
 6 | ELCS  = $(ELS:.el=.elc)
 7 | 
 8 | DEPS  = compat
 9 | DEPS += cond-let
10 | DEPS += emacsql
11 | 
12 | LOAD_PATH ?= $(addprefix -L ../,$(DEPS))
13 | LOAD_PATH += -L .
14 | 
15 | EMACS       ?= emacs
16 | EMACS_ARGS  ?=
17 | EMACS_Q_ARG ?= -Q
18 | EMACS_BATCH ?= $(EMACS) $(EMACS_Q_ARG) --batch $(EMACS_ARGS) $(LOAD_PATH)
19 | 
20 | all: lisp
21 | 
22 | help:
23 | 	$(info make all        -- Build lisp)
24 | 	$(info make lisp       -- Build lisp)
25 | 	$(info make redo       -- Build lisp from scratch)
26 | 	$(info make clean      -- Remove built files)
27 | 	@printf "\n"
28 | 
29 | redo: clean lisp
30 | 
31 | lisp: $(ELCS) autoloads check-declare
32 | 
33 | autoloads: $(PKG)-autoloads.el
34 | 
35 | %.elc: %.el
36 | 	@printf "Compiling $<\n"
37 | 	@$(EMACS_BATCH) --funcall batch-byte-compile $<
38 | 
39 | check-declare:
40 | 	@printf " Checking function declarations\n"
41 | 	@$(EMACS_BATCH) --eval "(check-declare-directory default-directory)"
42 | 
43 | CLEAN = $(ELCS) $(PKG)-autoloads.el
44 | 
45 | clean:
46 | 	@printf " Cleaning...\n"
47 | 	@rm -rf $(CLEAN)
48 | 
49 | $(PKG)-autoloads.el: $(ELS)
50 | 	@printf " Creating $@\n"
51 | 	@$(EMACS_BATCH) --load autoload --eval "\
52 | (let* ((file (expand-file-name \"$@\"))\
53 |        (generated-autoload-file file)\
54 |        (coding-system-for-write 'utf-8-emacs-unix)\
55 |        (backup-inhibited t)\
56 |        (version-control 'never)\
57 |        (inhibit-message t))\
58 |   (write-region (autoload-rubric file \"package\" t) nil file)\
59 |   (update-directory-autoloads default-directory))" \
60 | 	2>&1 | sed "/^Package autoload is deprecated$$/d"
61 | 


--------------------------------------------------------------------------------
/CHANGELOG:
--------------------------------------------------------------------------------
  1 | # -*- mode: org -*-
  2 | * v2.3.2    2025-11-01
  3 | 
  4 | Thoughts and whitespace.
  5 | 
  6 | * v2.3.1    2025-10-11
  7 | 
  8 | Thoughts and whitespace.
  9 | 
 10 | * v2.3.0    2025-09-01
 11 | 
 12 | Dropped support for Emacs 26 and 27.
 13 | 
 14 | * v2.2.2    2025-06-01
 15 | 
 16 | Thoughts and whitespace.
 17 | 
 18 | * v2.2.1    2025-03-01
 19 | 
 20 | Thoughts and whitespace.
 21 | 
 22 | * v2.2.0    2025-01-26
 23 | 
 24 | - ~closql-dset~ can now be told to ignore unknown connections.  ae8e78f
 25 | 
 26 | * v2.1.0    2024-12-01
 27 | 
 28 | - Adjusted to take advantage of EmacSQL v4.1.0.
 29 | 
 30 | * v2.0.0    2024-08-08
 31 | 
 32 | - Dropped support for Emacs 25.  22f67f5
 33 | 
 34 | - Database classes no longer derive from a connector class.  c3b34a6
 35 | 
 36 | - Added two new generic functions ~closql-dref~ and ~closql-dset~, which
 37 |   are used by our advices to ~eieio-oref~ and ~eieio-oset~, when they deal
 38 |   with slots whose values aren't completely stored in the object's
 39 |   primary table.  This makes it possible to implement slot-specific
 40 |   behavior.  296a356, 27aa7e5
 41 | 
 42 | - Originally the ~:closql-table~ slot property was used for slots that
 43 |   involved the use of two tables, but later it was additionally abused
 44 |   for slots that involve three tables.  Now such slots use a new slot
 45 |   property, ~:closql-tables~.  The values of these slots can now be
 46 |   accessed using ~oref,~ and the old hack ~closql--iref~ has been removed.
 47 | 
 48 | - The value of ~:closql-tables~ slots now begin with the id.  dae0256
 49 | 
 50 | - Accessing the value of indirect slots is much faster now, and the
 51 |   value is cached, making repeated slot access even faster.  09ad40f,
 52 |   dc8cacb
 53 | 
 54 | * v1.2.1    2022-02-16
 55 | 
 56 | - Refreshed metadata.
 57 | 
 58 | * v1.2.0    2021-09-28
 59 | 
 60 | - By default ~closql-get~ no longer proactively resolves all slots,
 61 |   which is never actually unnecessary but often extremely expensive.
 62 | 
 63 | * v1.1.0    2021-09-27
 64 | 
 65 | - Added support for alternative database connectors.
 66 |   The ~closql-database~ class is abstract now, making it necessary to
 67 |   define a class that derives from that and also from a connector
 68 |   class.
 69 | 
 70 | * v1.0.6    2021-06-16
 71 | 
 72 | - Adjusted to how unbound slots are represented in Emacs 28.
 73 | 
 74 | * v1.0.5    2021-05-30
 75 | 
 76 | - Cosmetics.
 77 | 
 78 | * v1.0.4    2020-07-20
 79 | 
 80 | - Added new functions ~closql--db-get~ and ~closql--db-set~.
 81 | 
 82 | * v1.0.3    2020-06-13
 83 | 
 84 | - When any class is autoloaded, then that could still caused a
 85 |   recursive load.
 86 | 
 87 | * v1.0.2    2020-05-22
 88 | 
 89 | - When any class is autoloaded, then that caused a recursive load.
 90 | 
 91 | * v1.0.1    2019-12-05
 92 | 
 93 | - Adjusted to incompatibles changes to Eieio internals that broke
 94 |   some code that relied on implementation details.
 95 | 
 96 | * v1.0.0    2018-10-31
 97 | 
 98 | - Added optional ~replace~ argument to ~closql-insert~.  It non-nil,
 99 |   then this function uses ~INSERT OR REPLACE INTO~ instead of just
100 |   ~INSERT INTO~, allowing the caller to replace an existing row.
101 | 
102 | - Added function ~closql-reload~, which, given a potentially outdated
103 |   object, returns an up-to-date object.
104 | 
105 | - Replaced the slot property ~:closql-columns~ with ~:closql-table~.  The
106 |   value has to be a table instead of a vector of columns and its name
107 |   can be different from that of the slot, which previously was not
108 |   possible.  The slots are now determined by querying the database.
109 | 
110 | - Added new experimental function ~closql--iref~.
111 | 
112 | * v0.6.0    2018-07-01
113 | 
114 | - Added new ~closql-object~ class slot ~closql-order-by~, which allows
115 |   specify how the values of a related ~:closql-class~ slot are ordered.
116 | 
117 | - An initially unbound slot for which neither ~:closql-class~ nor
118 |   ~:closql-columns~ is set caused an error in ~closql--resolve-slots~.
119 | 
120 | * v0.5.2    2018-05-21
121 | 
122 | - Fixed a bug that caused ~closql-insert~ to fail when using Emacs 25
123 |   ever since Emacs 26 is supported too.
124 | 
125 | - Added new utility function ~closql-format~.
126 | 
127 | * v0.5.1    2017-12-19
128 | 
129 | - A recent change on Emacs 27.0.50 causes an EmacSQL bug to surface.
130 |   That was fixed upstream and the dependency was bumped to bring in
131 |   that fix.
132 | 
133 | * v0.5.0    2017-11-27
134 | 
135 | - Emacs 26.1 will use a new ~record~ type instead of vectors.
136 |   Closql can now deal with both internal representations.
137 | 
138 | * v0.4.0    2017-09-19
139 | 
140 | - The value of a slot can now be a list of objects.  Like for a slot
141 |   whose value is a list of lists, the elements have to be uniform, in
142 |   this case they have to share a base-class, and they are unordered.
143 | 
144 |   Objects in such secondary tables can be queried directly, using the
145 |   same functions that are used to query objects in the primary table.
146 |   For secondary tables the new optional ~class~ argument of these query
147 |   functions has to be provided.
148 | 
149 |   Note that ~oset~ currently does not support "list of objects" slots.
150 | 
151 | - Access information is now stored in slots of the object base class
152 |   instead of in the database class.  This change was necessary to
153 |   allow storing objects of different types in different tables.
154 | 
155 |   The names of all of these slots are prefixed with ~closql-~.  The
156 |   existing slot ~database~ was renamed to ~closql-database~ and the slot
157 |   property ~:columns~ was renamed to ~:closql-columns~.
158 | 
159 | - Class tags are now automatically abbreviated when being stored in
160 |   the database because that gives friendlier results when querying it
161 |   direct.
162 | 
163 |   It was already possible to do that before by implementing the
164 |   generic functions ~closql--class-to-sql~ and ~closql--sql-to-class~.
165 |   These functions were replaced by the functions ~closql--abbrev-class~
166 |   and ~closql--expand-abbrev~, which have different signatures and allow
167 |   subclasses to strip a common prefix and/or suffix by setting the
168 |   object slots ~closql-class-prefix~ and ~closql-class-suffix~ instead of
169 |   having to define methods for these subclasses.
170 | 
171 | - Added new functions ~closql-query~.  It calls either ~closql-entries~
172 |   or if its ~select~ argument is non-nil ~closql-select~.  If ~select~ is a
173 |   symbol, then return a list of elements, unlike ~closql-select~, which
174 |   would return a list of lists with one element each.
175 | 
176 | - The function ~closql--where-class-in~ isn't merely intended for
177 |   internal use anymore and was renamed to ~closql-where-in-class~.
178 | 
179 | - Added new internal function ~closql--list-subbrevs~.
180 | 
181 | - The internal function ~closql--oref-default~ was removed.
182 | 
183 | - The function signature of ~closql--remake-instance~ changed.
184 | 
185 | * v0.3.3    2016-12-31
186 | 
187 | - Repository moved to https://github.com/emacscollective/closql.
188 | 
189 | * v0.3.2    2016-11-26
190 | 
191 | - Update links.
192 | 
193 | * v0.3.1    2016-11-03
194 | 
195 | - Fixed updating of rows in secondary tables when the key is ~nil~.
196 | 
197 | * v0.3.0    2016-10-25
198 | 
199 | - Setting the value of a slot whose value is stored in a secondary
200 |   table no longer deletes and recreates all rows.
201 | 
202 | - ~closql--db-init~ no longer sets the primary key of secondary tables.
203 | 
204 | * v0.2.0    2016-09-02
205 | 
206 | - Text properties are now being removed when storing string in the
207 |   database.
208 | 
209 | * v0.1.0    2016-04-15
210 | 
211 | - Initial public alpha release.
212 | 


--------------------------------------------------------------------------------
/closql.el:
--------------------------------------------------------------------------------
  1 | ;;; closql.el --- Store EIEIO objects using EmacSQL  -*- lexical-binding:t -*-
  2 | 
  3 | ;; Copyright (C) 2016-2025 Jonas Bernoulli
  4 | 
  5 | ;; Author: Jonas Bernoulli <emacs.closql@jonas.bernoulli.dev>
  6 | ;; Homepage: https://github.com/emacscollective/closql
  7 | ;; Keywords: extensions
  8 | 
  9 | ;; Package-Version: 2.3.2
 10 | ;; Package-Requires: (
 11 | ;;     (emacs   "28.1")
 12 | ;;     (compat  "30.1")
 13 | ;;     (cond-let "0.2")
 14 | ;;     (emacsql  "4.3"))
 15 | 
 16 | ;; SPDX-License-Identifier: GPL-3.0-or-later
 17 | 
 18 | ;; This file is free software: you can redistribute it and/or modify
 19 | ;; it under the terms of the GNU General Public License as published
 20 | ;; by the Free Software Foundation, either version 3 of the License,
 21 | ;; or (at your option) any later version.
 22 | ;;
 23 | ;; This file is distributed in the hope that it will be useful,
 24 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 25 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 26 | ;; GNU General Public License for more details.
 27 | ;;
 28 | ;; You should have received a copy of the GNU General Public License
 29 | ;; along with this file.  If not, see <https://www.gnu.org/licenses/>.
 30 | 
 31 | ;;; Commentary:
 32 | 
 33 | ;; Store uniform EIEIO objects in an EmacSQL database.  SQLite is used
 34 | ;; as backend.  This library imposes some restrictions on what kind of
 35 | ;; objects can be stored; it isn't intended to store arbitrary objects.
 36 | ;; All objects have to share a common superclass and subclasses cannot
 37 | ;; add any additional instance slots.
 38 | 
 39 | ;;; Code:
 40 | 
 41 | (require 'compat)
 42 | (require 'cond-let)
 43 | (require 'eieio)
 44 | (require 'eieio-base)
 45 | (require 'emacsql)
 46 | (require 'emacsql-sqlite)
 47 | 
 48 | (eval-when-compile (require 'subr-x))
 49 | 
 50 | (eval-when-compile
 51 |   (cl-pushnew 'connection eieio--known-slot-names))
 52 | 
 53 | (defmacro closql-with-transaction (db &rest body)
 54 |   (declare (indent 1))
 55 |   `(emacsql-with-transaction (oref ,db connection)
 56 |      ,@body))
 57 | 
 58 | ;;; Objects
 59 | 
 60 | (defclass closql-object ()
 61 |   ((closql-class-prefix  :initform nil :allocation :class)
 62 |    (closql-class-suffix  :initform nil :allocation :class)
 63 |    (closql-table         :initform nil :allocation :class)
 64 |    (closql-primary-key   :initform nil :allocation :class)
 65 |    (closql-foreign-key   :initform nil :allocation :class)
 66 |    (closql-order-by      :initform nil :allocation :class)
 67 |    (closql-database      :initform nil :initarg :closql-database))
 68 |   :abstract t)
 69 | 
 70 | (defun closql--closql-object-p (obj)
 71 |   ;; Prevent a recursive load when the class object is autoloaded.
 72 |   ;; See c1a9b816ec.  Don't #'quote; doesn't exist in older releases.
 73 |   (cl-letf (((symbol-function 'eieio--full-class-object)
 74 |              #'eieio--class-object))
 75 |     (closql-object--eieio-childp obj)))
 76 | 
 77 | ;;;; Oref
 78 | 
 79 | (define-advice eieio-oref (:around (fn obj slot) closql-object)
 80 |   "If OBJ is a `closql-object', delegate to `closql-oref'."
 81 |   (if (closql--closql-object-p obj)
 82 |       (closql-oref obj slot)
 83 |     (funcall fn obj slot)))
 84 | 
 85 | (defun closql--oref (obj slot)
 86 |   (aref obj (eieio--slot-name-index (eieio--object-class obj) slot)))
 87 | 
 88 | (defun closql--oref-default (class slot)
 89 |   (let ((class (if (symbolp class)
 90 |                    (cl--find-class class)
 91 |                  (eieio--object-class class))))
 92 |     (aref (eieio--class-class-allocation-values class)
 93 |           (eieio--class-slot-name-index class slot))))
 94 | 
 95 | (defun closql-oref (obj slot)
 96 |   (cl-check-type slot symbol)
 97 |   (let ((class (eieio--object-class obj)))
 98 |     (cond-let
 99 |       ([c (eieio--slot-name-index class slot)]
100 |        (let ((value (aref obj c)))
101 |          (if (eq value eieio--unbound)
102 |              (closql-dref obj slot)
103 |            value)))
104 |       ([c (eieio--class-slot-name-index class slot)]
105 |        (aref (eieio--class-class-allocation-values class) c))
106 |       ((slot-missing obj slot 'oref)))))
107 | 
108 | (cl-defgeneric closql-dref (obj slot)
109 |   (let ((c (eieio--slot-name-index (eieio--object-class obj) slot))
110 |         (db (closql--oref obj 'closql-database))
111 |         (props (closql--slot-properties obj slot)))
112 |     (cond-let
113 |       ([class (alist-get :closql-class props)]
114 |        (aset obj c
115 |              (closql--remake-instances class db
116 |                (emacsql
117 |                 db `[:select * :from $i1
118 |                      :where (= $i2 $s3)
119 |                      :order-by ,(or (closql--oref-default class 'closql-order-by)
120 |                                     [(asc $i4)])]
121 |                 (closql--oref-default class 'closql-table)
122 |                 (closql--oref-default class 'closql-foreign-key)
123 |                 (closql--oref obj (closql--oref-default obj 'closql-primary-key))
124 |                 (closql--oref-default class 'closql-primary-key)))))
125 |       ([table (alist-get :closql-table props)]
126 |        (let ((columns (closql--table-columns db table)))
127 |          (aset obj c
128 |                (mapcar
129 |                 (if (length= columns 2) #'cadr #'cdr)
130 |                 (emacsql
131 |                  db [:select * :from $i1
132 |                      :where (= $i2 $s3)
133 |                      :order-by [(asc $i4)]]
134 |                  table
135 |                  (car columns)
136 |                  (closql--oref obj (closql--oref-default obj 'closql-primary-key))
137 |                  (cadr columns))))))
138 |       ([tables (alist-get :closql-tables props)]
139 |        (pcase-let ((`(,slot-table ,data-table) tables))
140 |          (aset obj c
141 |                (mapcar
142 |                 #'cdr
143 |                 (emacsql
144 |                  db [:select $i1 :from $i2
145 |                      :join $i3 :on (= $i4 $i5)
146 |                      :where (= $i6 $s7)
147 |                      :order-by [(asc id)]]
148 |                  (intern (format "%s:*" data-table))
149 |                  data-table slot-table
150 |                  (intern (format "%s:id" slot-table))
151 |                  (intern (format "%s:id" data-table))
152 |                  (intern (format "%s:%s" slot-table
153 |                                  (closql--oref-default obj 'closql-table)))
154 |                  (closql--oref obj (closql--oref-default obj 'closql-primary-key))
155 |                  (closql--oref obj 'id))))))
156 |       ((slot-unbound obj (eieio--object-class obj) slot 'oref)))))
157 | 
158 | ;;;; Oset
159 | 
160 | (define-advice eieio-oset (:around (fn obj slot value) closql-object)
161 |   "If OBJ is a `closql-object', delegate to `closql-oset'."
162 |   (if (closql--closql-object-p obj)
163 |       (closql-oset obj slot value)
164 |     (funcall fn obj slot value)))
165 | 
166 | (defun closql--oset (obj slot value)
167 |   (aset obj (eieio--slot-name-index (eieio--object-class obj) slot) value))
168 | 
169 | (defun closql-oset (obj slot value)
170 |   (cl-check-type slot symbol)
171 |   (let ((class (eieio--object-class obj)))
172 |     (cond-let
173 |       ([c (eieio--slot-name-index class slot)]
174 |        (eieio--validate-slot-value class c value slot)
175 |        (when (and (not (eq slot 'closql-database))
176 |                   (closql--oref obj 'closql-database))
177 |          (closql-dset obj slot value))
178 |        (aset obj c value))
179 |       ([c (eieio--class-slot-name-index class slot)]
180 |        (eieio--validate-class-slot-value class c value slot)
181 |        (aset (eieio--class-class-allocation-values class) c value))
182 |       ((slot-missing obj slot 'oset value)))))
183 | 
184 | (cl-defgeneric closql-dset (obj slot value &optional drop-unknown)
185 |   (let* ((db    (closql--oref obj 'closql-database))
186 |          (key   (oref-default obj closql-primary-key))
187 |          (id    (closql--oref obj key))
188 |          (props (closql--slot-properties obj slot)))
189 |     (cond-let
190 |       ((alist-get :closql-class props)
191 |        (error "Not implemented for closql-class slots: oset"))
192 |       [[tables (alist-get :closql-tables props)]]
193 |       ([table (or (alist-get :closql-table props)
194 |                   (car tables))]
195 |        (closql-with-transaction db
196 |          (let ((columns (closql--table-columns db table)))
197 |            ;; Caller might have modified value in place.
198 |            (closql--oset obj slot eieio--unbound)
199 |            (let ((list1 (closql-oref obj slot))
200 |                  (list2 value)
201 |                  elt1 elt2)
202 |              (cond (tables
203 |                     (setq list1 (mapcar (lambda (e) (list (car e))) list1))
204 |                     (setq list2 (mapcar (if (atom (car list2))
205 |                                             #'list
206 |                                           (lambda (e) (list (car e))))
207 |                                         list2)))
208 |                    ((length= columns 2)
209 |                     (setq list1 (mapcar #'list list1))
210 |                     (setq list2 (mapcar #'list list2))))
211 |              ;; `list2' may not be sorted at all and `list1' has to
212 |              ;; be sorted because Elisp and SQLite sort differently.
213 |              (setq list1 (cl-sort list1 #'string< :key #'car))
214 |              (setq list2 (cl-sort list2 #'string< :key #'car))
215 |              (while (progn (setq elt1 (car list1))
216 |                            (setq elt2 (car list2))
217 |                            (or elt1 elt2))
218 |                (let ((key1 (car elt1))
219 |                      (key2 (car elt2)))
220 |                  (cond
221 |                   ((and elt1 (or (not elt2) (string< key1 key2)))
222 |                    (apply #'emacsql db
223 |                           `[:delete-from $i1
224 |                             :where ,(closql--where-equal (cons id elt1) 1)]
225 |                           table
226 |                           (cl-mapcan #'list columns (cons id elt1)))
227 |                    (pop list1))
228 |                   ((string= key1 key2)
229 |                    (unless (equal elt1 elt2)
230 |                      (cl-mapc
231 |                       (lambda (col val1 val2)
232 |                         (unless (equal val1 val2)
233 |                           (emacsql db [:update $i1 :set (= $i2 $s3)
234 |                                        :where (and (= $i4 $s5) (= $i6 $s7))]
235 |                                    table col val2
236 |                                    (car  columns) id
237 |                                    (cadr columns) key2)))
238 |                       (cddr columns)
239 |                       (cdr  elt1)
240 |                       (cdr  elt2)))
241 |                    (pop list1)
242 |                    (pop list2))
243 |                   (drop-unknown
244 |                    (ignore-errors
245 |                      (emacsql db [:insert-into $i1 :values $v2]
246 |                               table (vconcat (cons id elt2))))
247 |                    (pop list2))
248 |                   (t
249 |                    (emacsql db [:insert-into $i1 :values $v2]
250 |                             table (vconcat (cons id elt2)))
251 |                    (pop list2)))))))))
252 |       ((emacsql db [:update $i1 :set (= $i2 $s3) :where (= $i4 $s5)]
253 |                 (oref-default obj closql-table)
254 |                 slot
255 |                 (if (eq value eieio--unbound) 'eieio-unbound value)
256 |                 key id)))))
257 | 
258 | ;;;; Slot Properties
259 | 
260 | (defun closql--slot-properties (object-or-class slot)
261 |   (and-let ((desc (cl-find slot
262 |                            (closql--object-slots object-or-class)
263 |                            :key #'cl--slot-descriptor-name)))
264 |     (cl--slot-descriptor-props desc)))
265 | 
266 | (defun closql--object-slots (object-or-class)
267 |   (eieio-class-slots
268 |    (cond
269 |     ((eieio-object-p object-or-class) (eieio--object-class object-or-class))
270 |     ((eieio--class-p object-or-class) object-or-class)
271 |     ((find-class object-or-class 'error)))))
272 | 
273 | (defconst closql--slot-properties '(:closql-class :closql-table :closql-tables))
274 | 
275 | (define-advice eieio-defclass-internal
276 |     (:after (cname _superclasses slots _options) closql-object)
277 |   "Handle additional slot properties used by `closql-object' derived classes."
278 |   (when-let* ((class (cl--find-class cname))
279 |               (_(child-of-class-p class 'closql-object)))
280 |     (pcase-dolist (`(,name . ,slot) slots)
281 |       (let ((desc (cl-find name
282 |                            (cl-coerce (eieio--class-slots class) 'list)
283 |                            :key (lambda (elt) (aref elt 1)))))
284 |         (dolist (prop closql--slot-properties)
285 |           (when-let
286 |               ((v (plist-get slot prop)))
287 |             (setf (alist-get prop (cl--slot-descriptor-props desc)) v)))))))
288 | 
289 | (define-advice eieio--slot-override
290 |     (:after (old new _skipnil) closql-object)
291 |   "Handle additional slot properties used by `closql-object' derived classes."
292 |   (dolist (prop closql--slot-properties)
293 |     (when-let
294 |         ((v (alist-get prop (cl--slot-descriptor-props new))))
295 |       (setf (alist-get prop (cl--slot-descriptor-props old)) v))))
296 | 
297 | ;;; Database
298 | 
299 | (defclass closql-database (eieio-singleton)
300 |   ((name         :initform nil :allocation :class)
301 |    (object-class :initform nil :allocation :class)
302 |    (file         :initform nil :allocation :class)
303 |    (schemata     :initform nil :allocation :class)
304 |    (version      :initform nil :allocation :class)
305 |    (disabled     :initform nil :allocation :class)
306 |    (connection   :initform nil :initarg :connection))
307 |   :abstract t)
308 | 
309 | (cl-defmethod closql-db ((class (subclass closql-database))
310 |                          &optional livep connection-class)
311 |   (cond-let*
312 |     ([db (oref-default class singleton)]
313 |      [conn (and (not (eq db eieio--unbound))
314 |                 (oref db connection))]
315 |      [_(emacsql-live-p conn)]
316 |      db)
317 |     ((not livep)
318 |      (let* ((file (closql--db-prepare-storage class))
319 |             (connection-class (or connection-class
320 |                                   (emacsql-sqlite-default-connection)))
321 |             (conn (make-instance connection-class :file file))
322 |             (db (make-instance class))) ; ignores slot arguments
323 |        (oset db connection conn)
324 |        (emacsql conn [:pragma (= foreign-keys on)])
325 |        (cond-let
326 |          ((not (emacsql-sqlite-list-tables db))
327 |           (closql--db-create-schema db))
328 |          [[code-version (oref-default db version)]
329 |           [data-version (closql--db-get-version db)]]
330 |          ((< code-version data-version)
331 |           (message "Please update %s package (database schema version %s < %s)"
332 |                    (oref-default db name) code-version data-version)
333 |           (oset-default class disabled t)
334 |           (emacsql-close db)
335 |           (setq db nil))
336 |          ((closql--db-update-schema db)))
337 |        db))))
338 | 
339 | (cl-defmethod closql--db-prepare-storage ((class (subclass closql-database)))
340 |   (when-let ((file (oref-default class file)))
341 |     (when (symbolp file)
342 |       (setq file (symbol-value file)))
343 |     (make-directory (file-name-directory file) t)
344 |     file))
345 | 
346 | (cl-defmethod closql--db-create-schema ((db closql-database))
347 |   (closql-with-transaction db
348 |     (pcase-dolist (`(,table . ,schema)
349 |                    (symbol-value (oref-default db schemata)))
350 |       (emacsql db [:create-table $i1 $S2] table schema))
351 |     (closql--db-set-version db (oref-default db version))))
352 | 
353 | (cl-defmethod closql--db-update-schema ((db closql-database))
354 |   (let ((code-version (oref-default db version))
355 |         (data-version (closql--db-get-version db)))
356 |     (when (< data-version code-version)
357 |       (oset-default db disabled t)
358 |       (emacsql-close db)
359 |       (error "Please update %s database (schema version %s < %s)"
360 |              (oref-default db name) data-version code-version))))
361 | 
362 | (cl-defmethod emacsql-live-p ((db closql-database))
363 |   (and-let ((conn (oref db connection)))
364 |     (emacsql-live-p conn)))
365 | 
366 | (cl-defmethod emacsql-enable-debugging ((db closql-database))
367 |   (emacsql-enable-debugging (oref db connection)))
368 | 
369 | (cl-defmethod emacsql-close ((db closql-database))
370 |   (emacsql-close (oref db connection))
371 |   (oset db connection nil))
372 | 
373 | (cl-defmethod emacsql ((db closql-database) sql &rest args)
374 |   (mapcar #'closql--extern-unbound
375 |           (apply #'emacsql (oref db connection) sql
376 |                  (mapcar (lambda (arg)
377 |                            (if (stringp arg)
378 |                                (let ((copy (copy-sequence arg)))
379 |                                  (set-text-properties 0 (length copy) nil copy)
380 |                                  copy)
381 |                              arg))
382 |                          args))))
383 | 
384 | (cl-defmethod closql-insert ((db closql-database) obj &optional replace)
385 |   (closql--oset obj 'closql-database db)
386 |   (let (alist)
387 |     (dolist (slot (eieio-class-slots (eieio--object-class obj)))
388 |       (setq  slot (cl--slot-descriptor-name slot))
389 |       (when (alist-get :closql-table (closql--slot-properties obj slot))
390 |         (push (cons slot (closql-oref obj slot)) alist)
391 |         (closql--oset obj slot eieio--unbound)))
392 |     (closql-with-transaction db
393 |       (emacsql db
394 |                (if replace
395 |                    [:insert-or-replace-into $i1 :values $v2]
396 |                  [:insert-into $i1 :values $v2])
397 |                (oref-default obj closql-table)
398 |                (pcase-let ((`(,class ,_db . ,values)
399 |                             (closql--intern-unbound
400 |                              (closql--coerce obj 'list))))
401 |                  (vconcat (cons (closql--abbrev-class class) values))))
402 |       (pcase-dolist (`(,slot . ,value) alist)
403 |         (closql-dset obj slot value))))
404 |   obj)
405 | 
406 | (cl-defmethod closql-delete ((obj closql-object))
407 |   (let ((key (oref-default obj closql-primary-key)))
408 |     (emacsql (closql--oref obj 'closql-database)
409 |              [:delete-from $i1 :where (= $i2 $s3)]
410 |              (oref-default obj closql-table)
411 |              key
412 |              (closql--oref obj key))))
413 | 
414 | (cl-defmethod closql-reload ((obj closql-object))
415 |   (or (closql-get (closql--oref obj 'closql-database)
416 |                   (closql--oref obj (oref-default obj closql-primary-key))
417 |                   (eieio-object-class obj))
418 |       (error "Cannot reload object")))
419 | 
420 | (cl-defmethod closql-get ((db closql-database) ident &optional class resolve)
421 |   (unless class
422 |     (setq class (oref-default db object-class)))
423 |   (and-let ((row (car (emacsql db [:select * :from $i1
424 |                                    :where (= $i2 $s3)]
425 |                                (oref-default class closql-table)
426 |                                (oref-default class closql-primary-key)
427 |                                ident))))
428 |     (closql--remake-instance class db row resolve)))
429 | 
430 | (cl-defmethod closql-query ((db closql-database) &optional select pred class)
431 |   (if select
432 |       (let ((value (closql-select db select pred class)))
433 |         (if (and select (symbolp select))
434 |             (mapcar #'car value)
435 |           value))
436 |     (closql-entries db pred class)))
437 | 
438 | (cl-defmethod closql-entries ((db closql-database) &optional pred class)
439 |   (unless class
440 |     (setq class (oref-default db object-class)))
441 |   (mapcar (lambda (row)
442 |             (closql--remake-instance class db row))
443 |           (closql-select db '* pred class)))
444 | 
445 | (cl-defmethod closql-select ((db closql-database) select &optional pred class)
446 |   (unless class
447 |     (setq class (oref-default db object-class)))
448 |   (emacsql db
449 |            `[:select $i1 :from $i2
450 |              ,@(and pred [:where class :in $v3])
451 |              ,@(if-let ((order (oref-default class closql-order-by)))
452 |                    (list :order-by order)
453 |                  '(:order-by [(asc $i4)]))]
454 |            select
455 |            (oref-default class closql-table)
456 |            (and pred (closql-where-class-in pred db))
457 |            (oref-default class closql-primary-key)))
458 | 
459 | (defun closql--table-columns (db table)
460 |   (mapcar #'cadr (emacsql db [:pragma (funcall table-info $i1)] table)))
461 | 
462 | (defun closql--db-get-version (db)
463 |   (caar (emacsql db [:pragma user-version])))
464 | 
465 | (defun closql--db-set-version (db version)
466 |   (cl-assert (integerp version))
467 |   (emacsql db [:pragma (= user-version $s1)] version))
468 | 
469 | ;;; Object/Row Conversion
470 | 
471 | (cl-defmethod closql--remake-instance ((class (subclass closql-object))
472 |                                        db row &optional resolve)
473 |   (pcase-let*
474 |       ((`(,abbrev . ,values) (closql--extern-unbound row))
475 |        (class-sym (closql--expand-abbrev class abbrev))
476 |        (class-obj (eieio--class-object class-sym))
477 |        (obj (copy-sequence (eieio--class-default-object-cache class-obj)))
478 |        (values (apply #'vector (cons db values))))
479 |     (dotimes (i (length (eieio--class-slots class-obj)))
480 |       (aset obj (1+ i) (aref values i)))
481 |     (when resolve
482 |       (closql--resolve-slots obj))
483 |     (when eieio-backward-compatibility
484 |       (aset obj 0 class-sym))
485 |     obj))
486 | 
487 | (defun closql--remake-instances (class db rows)
488 |   (declare (indent defun))
489 |   (mapcar (lambda (row)
490 |             (closql--remake-instance class db row))
491 |           rows))
492 | 
493 | (cl-defmethod closql--resolve-slots ((obj closql-object))
494 |   (dolist (slot (eieio-class-slots (eieio--object-class obj)))
495 |     (setq  slot (cl--slot-descriptor-name slot))
496 |     (when (and (not (slot-boundp obj slot))
497 |                (let ((props (closql--slot-properties obj slot)))
498 |                  (or (alist-get :closql-class props)
499 |                      (alist-get :closql-table props))))
500 |       (closql--oset obj slot (closql-oref obj slot)))))
501 | 
502 | (defun closql--intern-unbound (row)
503 |   (mapcar (lambda (elt)
504 |             (if (eq elt eieio--unbound) 'eieio-unbound elt))
505 |           row))
506 | 
507 | (defun closql--extern-unbound (row)
508 |   (mapcar (lambda (elt)
509 |             (if (eq elt 'eieio-unbound) eieio--unbound elt))
510 |           row))
511 | 
512 | (defun closql--coerce (object type)
513 |   (cl-coerce (let* ((length (length object))
514 |                     (vector (make-vector length -1)))
515 |                (dotimes (i length)
516 |                  (aset vector i (aref object i)))
517 |                ;; Do not assume eieio-backward-compatibility is enabled.
518 |                (when (eieio--class-p (aref vector 0))
519 |                  (aset vector 0 (eieio--class-name (aref vector 0))))
520 |                vector)
521 |              type))
522 | 
523 | (cl-defmethod closql--abbrev-class ((class (subclass closql-object)))
524 |   (let ((name (symbol-name class))
525 |         (prefix (oref-default class closql-class-prefix))
526 |         (suffix (oref-default class closql-class-suffix)))
527 |     (intern (substring name
528 |                        (if prefix    (length prefix)    0)
529 |                        (if suffix (- (length suffix)) nil)))))
530 | 
531 | (cl-defmethod closql--expand-abbrev ((class (subclass closql-object)) abbrev)
532 |   (intern (concat (oref-default class closql-class-prefix)
533 |                   (symbol-name abbrev)
534 |                   (oref-default class closql-class-suffix))))
535 | 
536 | (defun closql--where-equal (value offset)
537 |   (vector
538 |    (cons 'and
539 |          (mapcar (lambda (v)
540 |                    (if v
541 |                        (list '=
542 |                              (intern (format "$i%i" (cl-incf offset)))
543 |                              (intern (format "$s%i" (cl-incf offset))))
544 |                      (list 'isnull
545 |                            (intern (format "$i%i" (1- (cl-incf offset 2)))))))
546 |                  value))))
547 | 
548 | (defun closql-where-class-in (args &optional db)
549 |   (when (symbolp args)
550 |     (setq args (list args)))
551 |   (cond
552 |    ((vectorp args)
553 |     (unless db
554 |       (error "closql-where-class-in: DB cannot be nil if ARGS is a vector"))
555 |     (let ((class (oref-default db object-class))
556 |           (abbrevs nil))
557 |       (mapc (lambda (arg)
558 |               (let ((str (symbol-name arg)))
559 |                 (unless (string-match "\\`\\(!\\)?\\([^*]+\\)\\(\\*\\)?\\'" str)
560 |                   (error "`closql-where-class-in': invalid type: %s" arg))
561 |                 (let* ((exclude (match-beginning 1))
562 |                        (a (intern (match-string 2 str)))
563 |                        (a (cond ((match-beginning 3)
564 |                                  (closql--list-subabbrevs
565 |                                   (closql--expand-abbrev class a)))
566 |                                 ((not (class-abstract-p
567 |                                        (closql--expand-abbrev class a)))
568 |                                  (list a)))))
569 |                   (setq abbrevs
570 |                         (if exclude
571 |                             (cl-set-difference abbrevs a)
572 |                           (nconc abbrevs a))))))
573 |             args)
574 |       (vconcat abbrevs)))
575 |    ((vconcat
576 |      (mapcar #'closql--abbrev-class
577 |              (mapcan (lambda (sym)
578 |                        (let ((str (symbol-name sym)))
579 |                          (cond ((string-suffix-p "--eieio-childp" str)
580 |                                 (closql--list-subclasses
581 |                                  (intern (substring str 0 -14)) nil))
582 |                                ((string-suffix-p "-p" str)
583 |                                 (list (intern (substring str 0 -2))))
584 |                                ((list sym)))))
585 |                      args))))))
586 | 
587 | (defun closql--list-subclasses (class &optional result)
588 |   (unless (class-abstract-p class)
589 |     (cl-pushnew class result))
590 |   (dolist (child (eieio--class-children (cl--find-class class)))
591 |     (setq result (closql--list-subclasses child result)))
592 |   result)
593 | 
594 | (cl-defmethod closql--list-subabbrevs ((class (subclass closql-object))
595 |                                        &optional wildcards)
596 |   (sort (named-let types ((class class))
597 |           (let ((children (eieio--class-children (cl--find-class class)))
598 |                 ;; An abstract base-class may violate its own naming rules.
599 |                 (abbrev (ignore-errors (closql--abbrev-class class))))
600 |             (nconc (and (not (class-abstract-p class)) (list abbrev))
601 |                    (and wildcards children
602 |                         (list (if abbrev (intern (format "%s*" abbrev)) '*)))
603 |                    (mapcan #'types children))))
604 |         #'string<))
605 | 
606 | (cl-defmethod closql--set-object-class ((db closql-database) obj class)
607 |   (let* ((table (oref-default obj closql-table))
608 |          (key   (oref-default obj closql-primary-key))
609 |          (id    (closql--oref obj key)))
610 |     (aset obj 0
611 |           (aref (copy-sequence
612 |                  (eieio--class-default-object-cache
613 |                   (eieio--class-object class)))
614 |                 0))
615 |     (emacsql db [:update $i1 :set (= class $s2) :where (= $i3 $s4)]
616 |              table
617 |              (closql--abbrev-class class)
618 |              key id)))
619 | 
620 | ;;; Utilities
621 | 
622 | (defun closql-format (object string &rest slots)
623 |   "Format a string out of a format STRING and an OBJECT's SLOTS.
624 | 
625 | STRING is a format-string like for `format'.  OBJECT is an Eieio
626 | object and SLOTS are slots of that object, their values are used
627 | like `format' uses its OBJECTS arguments (which are unrelated to
628 | this function's OBJECT argument, they just have similar names).
629 | 
630 | While this function does not have much to do with the purpose of
631 | `closql', it is being defined here anyway because Eieio does not
632 | define a similar function under a more appropriate name such as
633 | `eieio-format'."
634 |   (apply #'format string
635 |          (mapcar (lambda (slot) (eieio-oref object slot)) slots)))
636 | 
637 | ;;; _
638 | (provide 'closql)
639 | ;; Local Variables:
640 | ;; read-symbol-shorthands: (
641 | ;;   ("and-let"  . "cond-let--and-let")
642 | ;;   ("if-let"   . "cond-let--if-let")
643 | ;;   ("when-let" . "cond-let--when-let"))
644 | ;; indent-tabs-mode: nil
645 | ;; End:
646 | ;;; closql.el ends here
647 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 <https://www.gnu.org/licenses/>.
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 |     <program>  Copyright (C) <year>  <name of author>
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 | <https://www.gnu.org/licenses/>.
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 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------