├── images ├── add-row.gif ├── execute.gif ├── delete-rows.gif ├── add-row_orig.gif ├── execute_orig.gif ├── select-earth.gif ├── sqlite-edits.gif ├── sqlite-forward.gif ├── compose-execute.gif ├── delete-rows_orig.gif ├── sqlite-previous.gif ├── select-earth_orig.gif └── compose-execute_orig.gif ├── README.org ├── sqlite-mode-extras.el └── LICENSE /images/add-row.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/add-row.gif -------------------------------------------------------------------------------- /images/execute.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/execute.gif -------------------------------------------------------------------------------- /images/delete-rows.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/delete-rows.gif -------------------------------------------------------------------------------- /images/add-row_orig.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/add-row_orig.gif -------------------------------------------------------------------------------- /images/execute_orig.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/execute_orig.gif -------------------------------------------------------------------------------- /images/select-earth.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/select-earth.gif -------------------------------------------------------------------------------- /images/sqlite-edits.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/sqlite-edits.gif -------------------------------------------------------------------------------- /images/sqlite-forward.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/sqlite-forward.gif -------------------------------------------------------------------------------- /images/compose-execute.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/compose-execute.gif -------------------------------------------------------------------------------- /images/delete-rows_orig.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/delete-rows_orig.gif -------------------------------------------------------------------------------- /images/sqlite-previous.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/sqlite-previous.gif -------------------------------------------------------------------------------- /images/select-earth_orig.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/select-earth_orig.gif -------------------------------------------------------------------------------- /images/compose-execute_orig.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/xenodium/sqlite-mode-extras/HEAD/images/compose-execute_orig.gif -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | 👉 [[https://github.com/sponsors/xenodium][Support this work via GitHub Sponsors]] 2 | 3 | * sqlite-mode-extras 4 | 5 | An experimental package to extend Emacs 29's sqlite-mode. 6 | 7 | ⚠️ Experimental package ⚠️ 8 | 9 | I've received enough requests to put this on MELPA from folks that have found the package stable and helpful. 10 | 11 | Having said that, I want to be upfront that I haven't tested the code thoroughly, so please use at own risk (please back up your database). 12 | 13 | * Recommended bindings and installation 14 | 15 | Install from MELPA and enable default bindings via =sqlite-extras-minor-mode=. 16 | 17 | #+begin_src emacs-lisp :lexical no 18 | (use-package sqlite-mode-extras 19 | :ensure t 20 | :hook ((sqlite-mode . sqlite-extras-minor-mode))) 21 | #+end_src 22 | 23 | * What kind of extras? 24 | 25 | - =sqlite-mode-extras-tab-dwim=: Tab navigation. 26 | 27 | #+ATTR_HTML: :width 75% 28 | [[file:images/sqlite-forward.gif]] 29 | 30 | #+ATTR_HTML: :width 75% 31 | [[file:images/sqlite-previous.gif]] 32 | 33 | - =sqlite-mode-extras-ret-dwim=: Edit field. 34 | 35 | #+ATTR_HTML: :width 90% 36 | [[file:images/sqlite-edits.gif]] 37 | 38 | - =sqlite-mode-extras-compose-and-execute=: Compose and execute a query. 39 | 40 | #+ATTR_HTML: :width 90% 41 | [[file:images/compose-execute.gif]] 42 | - =sqlite-mode-extras-execute=: Execute a query. 43 | 44 | #+ATTR_HTML: :width 90% 45 | [[file:images/execute.gif]] 46 | - =sqlite-mode-extras-add-row=: Add row to table at point. 47 | 48 | #+ATTR_HTML: :width 90% 49 | [[file:images/add-row.gif]] 50 | - =sqlite-mode-extras-delete-row-dwim=: Similar to =sqlite-mode-delete= but also enables deleting range in region. 51 | 52 | #+ATTR_HTML: :width 90% 53 | [[file:images/delete-rows.gif]] 54 | - =sqlite-mode-extras-refresh=: Refreshes the buffer re-querying the database. 55 | - =sqlite-mode-extras-ret-dwim=: If on table, toggle expansion. If on row, edit it. 56 | - =sqlite-mode-extras-execute-and-display-select-query=: Executes a query and displays results. 57 | 58 | #+ATTR_HTML: :width 90% 59 | [[file:images/select-earth.gif]] 60 | 61 | * Customizations 62 | 63 | #+BEGIN_SRC emacs-lisp :results table :colnames '("Custom variable" "Description") :exports results 64 | (let ((rows)) 65 | (mapatoms 66 | (lambda (symbol) 67 | (when (and (string-match "^sqlite-mode-extras" 68 | (symbol-name symbol)) 69 | (custom-variable-p symbol)) 70 | (push `(,symbol 71 | ,(car 72 | (split-string 73 | (or (get (indirect-variable symbol) 74 | 'variable-documentation) 75 | (get symbol 'variable-documentation) 76 | "") 77 | "\n"))) 78 | rows)))) 79 | rows) 80 | #+END_SRC 81 | 82 | #+RESULTS: 83 | | Custom variable | Description | 84 | |------------------------------------------+-----------------------------------------| 85 | | sqlite-mode-extras-auto-complete-enabled | Enable value lookup on database column. | 86 | 87 | * Commands 88 | #+BEGIN_SRC emacs-lisp :results table :colnames '("Binding" "Command" "Description") :exports results 89 | (let ((rows)) 90 | (mapatoms 91 | (lambda (symbol) 92 | (when (and (string-match "^sqlite-mode-extras" 93 | (symbol-name symbol)) 94 | (commandp symbol)) 95 | (push `(,(string-join 96 | (seq-filter 97 | (lambda (symbol) 98 | (not (string-match "menu" symbol))) 99 | (mapcar 100 | (lambda (keys) 101 | (key-description keys)) 102 | (or 103 | (where-is-internal 104 | (symbol-function symbol) 105 | comint-mode-map 106 | nil nil (command-remapping 'comint-next-input)) 107 | (where-is-internal 108 | symbol sqlite-extras-minor-mode-map nil nil (command-remapping symbol)) 109 | (where-is-internal 110 | (symbol-function symbol) 111 | sqlite-extras-minor-mode-map nil nil (command-remapping symbol))))) " or ") 112 | ,(symbol-name symbol) 113 | ,(car 114 | (split-string 115 | (or (documentation symbol t) "") 116 | "\n"))) 117 | rows)))) 118 | rows) 119 | #+END_SRC 120 | 121 | #+RESULTS: 122 | | Binding | Command | Description | 123 | |----------------+-----------------------------------------------------+---------------------------------------------------| 124 | | g | sqlite-mode-extras-refresh | Refresh all listings and table queries. | 125 | | E | sqlite-mode-extras-execute | Execute a query. | 126 | | C | sqlite-mode-extras-compose-and-execute | Compose and execute a query. | 127 | | S | sqlite-mode-extras-execute-and-display-select-query | Execute a SELECT QUERY. | 128 | | | sqlite-mode-extras-edit-row-field | Edit current row's field. | 129 | | | sqlite-mode-extras-next-column | Navigate to next column. | 130 | | | sqlite-mode-extras-mode | | 131 | | + | sqlite-mode-extras-add-row | Add a row to current table. | 132 | | DEL or D | sqlite-mode-extras-delete-row-dwim | Delete current row or rows in region. | 133 | | or b | sqlite-mode-extras-backtab-dwim | Like `sqlite-mode-extras-tab-dwim' but backwards. | 134 | | RET | sqlite-mode-extras-ret-dwim | DWIM binding for RET. | 135 | | or f | sqlite-mode-extras-tab-dwim | DWIM binding for TAB. | 136 | 137 | 👉 Find this useful? [[https://github.com/sponsors/xenodium][Support this work via GitHub Sponsors]] 138 | -------------------------------------------------------------------------------- /sqlite-mode-extras.el: -------------------------------------------------------------------------------- 1 | ;;; sqlite-mode-extras.el --- Extensions for sqlite-mode -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2024 Alvaro Ramirez 4 | 5 | ;; Author: Alvaro Ramirez https://xenodium.com 6 | ;; URL: https://github.com/xenodium/sqlite-mode-extras 7 | ;; Version: 0.7 8 | ;; Package-Requires: ((emacs "29.1")) 9 | 10 | ;;; License: 11 | ;; 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 | ;; Helper additions for `sqlite-mode'. 29 | 30 | ;; Warning: While I've received plenty of requests to release as a 31 | ;; package, please note I still consider this package experimental. 32 | ;; Please back up your databases when using this package. 33 | 34 | ;; Suggested key bindings: 35 | ;; 36 | ;; (use-package sqlite-mode-extras 37 | ;; :bind (:map 38 | ;; sqlite-mode-map 39 | ;; ("n" . next-line) 40 | ;; ("p" . previous-line) 41 | ;; ("b" . sqlite-mode-extras-backtab-dwim) 42 | ;; ("f" . sqlite-mode-extras-tab-dwim) 43 | ;; ("+" . sqlite-mode-extras-add-row) 44 | ;; ("D" . sqlite-mode-extras-delete-row-dwim) 45 | ;; ("C" . sqlite-mode-extras-compose-and-execute) 46 | ;; ("E" . sqlite-mode-extras-execute) 47 | ;; ("S" . sqlite-mode-extras-execute-and-display-select-query) 48 | ;; ("DEL" . sqlite-mode-extras-delete-row-dwim) 49 | ;; ("g" . sqlite-mode-extras-refresh) 50 | ;; ("" . sqlite-mode-extras-backtab-dwim) 51 | ;; ("" . sqlite-mode-extras-tab-dwim) 52 | ;; ("RET" . sqlite-mode-extras-ret-dwim))) 53 | 54 | 55 | ;;; Code: 56 | 57 | (require 'sqlite-mode) 58 | (require 'view) 59 | 60 | (defcustom sqlite-mode-extras-auto-complete-enabled t 61 | "Enable value lookup on database column. 62 | May cause performance issues on large tables." 63 | :type 'boolean 64 | :group 'sqlite-mode-extras-group) 65 | 66 | (defun sqlite-mode-extras-execute () 67 | "Execute a query." 68 | (interactive) 69 | (let* ((query (read-string "Execute query: "))) 70 | (if (sqlite-mode-extras--selected-table-name-in-query query) 71 | (sqlite-mode-extras-execute-and-display-select-query query) 72 | (mapc (lambda (query) 73 | (setq query (string-trim query)) 74 | (unless (string-empty-p query) 75 | (sqlite-execute sqlite--db query))) 76 | (string-split query ";")) 77 | (sqlite-mode-extras-refresh)))) 78 | 79 | (defun sqlite-mode-extras-compose-and-execute () 80 | "Compose and execute a query." 81 | (interactive) 82 | (let* ((db-buffer (current-buffer)) 83 | (buffer-name "*SQLite compose query*") 84 | (buffer (get-buffer-create buffer-name)) 85 | (instructions (concat "Type " 86 | (propertize "C-c C-c" 'face 'help-key-binding) 87 | " to execute query. " 88 | (propertize "C-c C-k" 'face 'help-key-binding) 89 | " to cancel and exit. ")) 90 | (query)) 91 | (add-to-list 'display-buffer-alist 92 | (cons buffer 93 | '((display-buffer-below-selected) 94 | (split-window-sensibly)))) 95 | (with-current-buffer buffer 96 | (visual-line-mode +1) 97 | (when view-mode 98 | (view-mode -1) 99 | (erase-buffer)) 100 | (local-set-key (kbd "C-c C-k") 101 | (lambda () (interactive) 102 | (quit-window t (get-buffer-window buffer)) 103 | (message "exit"))) 104 | (local-set-key (kbd "C-c C-c") 105 | (lambda () 106 | (interactive) 107 | (when (string-empty-p 108 | (string-trim 109 | (buffer-substring-no-properties 110 | (point-min) (point-max)))) 111 | (erase-buffer) 112 | (user-error "Nothing to execute")) 113 | (if view-mode 114 | (progn 115 | (view-mode -1) 116 | (erase-buffer) 117 | (message instructions)) 118 | (setq query 119 | (string-trim 120 | (buffer-substring-no-properties 121 | (point-min) (point-max)))) 122 | (view-mode +1) 123 | (setq view-exit-action 'kill-buffer) 124 | (with-current-buffer db-buffer 125 | (if (sqlite-mode-extras--selected-table-name-in-query query) 126 | (sqlite-mode-extras-execute-and-display-select-query query) 127 | (mapc (lambda (query) 128 | (setq query (string-trim query)) 129 | (unless (string-empty-p query) 130 | (sqlite-execute sqlite--db query))) 131 | (string-split query ";")) 132 | (sqlite-mode-extras-refresh))) 133 | (quit-window t (get-buffer-window buffer))))) 134 | (message instructions)) 135 | (pop-to-buffer buffer-name))) 136 | 137 | (defun sqlite-mode-extras-completing-read-field (table column) 138 | "Do a grouped select to get some completion candidates. 139 | Takes TABLE to query and COLUMN to select from for completions." 140 | (delq nil (flatten-tree (sqlite-execute 141 | sqlite--db 142 | (format "SELECT %s FROM %s GROUP BY %s limit 100" 143 | column 144 | table 145 | column))))) 146 | 147 | (defun sqlite-mode-extras-edit-row-field () 148 | "Edit current row's field." 149 | (interactive) 150 | (when-let* ((table (sqlite-mode-extras--type-property-at-point)) 151 | (row (sqlite-mode-extras--row-property-at-point)) 152 | (columns (sqlite-mode-extras--table-header-column-details 153 | (sqlite-mode-extras--table-header-line))) 154 | (column (sqlite-mode-extras--resolve-table-column)) 155 | (value (if (numberp (sqlite-mode-extras--row-field-value-at-point)) 156 | (read-number (format "%s: " column) 157 | (sqlite-mode-extras--row-field-value-at-point)) 158 | (if sqlite-mode-extras-auto-complete-enabled 159 | (let ((completions (sqlite-mode-extras-completing-read-field (cdr table) column ))) 160 | (completing-read (format "%s: " column) 161 | completions 162 | nil 163 | nil 164 | (sqlite-mode-extras--row-field-value-at-point))) 165 | (read-string (format "%s: " column) 166 | (sqlite-mode-extras--row-field-value-at-point)))))) 167 | (unless (string-equal (car (seq-first columns)) "id") 168 | (error "First column must be 'id'")) 169 | (sqlite-execute 170 | sqlite--db 171 | (format "UPDATE %s SET %s = ? WHERE rowid = ?" 172 | (sqlite-mode-extras--assert-table-name (cdr table)) 173 | column) 174 | (list value (car row))) 175 | (sqlite-mode-extras-refresh))) 176 | 177 | (defun sqlite-mode-extras-delete-row-dwim () 178 | "Delete current row or rows in region." 179 | (interactive) 180 | (cond ((sqlite-mode-extras--on-select-query-p) 181 | (sqlite-mode-extras--toggle-query-results-display t)) 182 | ((sqlite-mode-extras--on-row-p) 183 | (when-let* ((table (sqlite-mode-extras--type-property-at-point)) 184 | (pos (point)) 185 | (rows (if (region-active-p) 186 | (let* ((start (region-beginning)) 187 | (end (region-end)) 188 | (rows)) 189 | (setq pos (min start end)) 190 | (save-excursion 191 | (goto-char start) 192 | (while (and (< (point) end) (not (eobp))) 193 | (when-let ((row (sqlite-mode-extras--row-property-at-point))) 194 | (setq rows (cons row rows))) 195 | (forward-line 1))) 196 | rows) 197 | (list (sqlite-mode-extras--row-property-at-point)))) 198 | (rowids (mapconcat (lambda (item) (number-to-string (car item))) rows ", ")) 199 | (columns (sqlite-mode-extras--table-header-column-details 200 | (sqlite-mode-extras--table-header-line)))) 201 | (unless (string-equal (car (seq-first columns)) "id") 202 | (error "First column must be 'id'")) 203 | (unless (yes-or-no-p (format "Delete from '%s' rowid = %s?" 204 | (sqlite-mode-extras--assert-table-name (cdr table)) 205 | rowids)) 206 | (user-error "Aborted")) 207 | (sqlite-execute 208 | sqlite--db 209 | (format "DELETE FROM %s WHERE rowid IN (%s);" 210 | (sqlite-mode-extras--assert-table-name (cdr table)) 211 | rowids)) 212 | (sqlite-mode-extras-refresh))))) 213 | 214 | (defun sqlite-mode-extras--assert-table-name (name) 215 | "Check if NAME is a valid SQLite table name and fail otherwise." 216 | (if (string-match-p "^[a-zA-Z_][a-zA-Z0-9_]*$" name) 217 | name 218 | (error "\"%s\" is not a valid table name" name))) 219 | 220 | (defun sqlite-mode-extras--point-at-last-column-p () 221 | "Return t if point is on a table's last column." 222 | (when-let ((last-column (car (car (last (sqlite-mode-extras--table-header-column-details 223 | (sqlite-mode-extras--table-header-line))))))) 224 | (equal (sqlite-mode-extras--resolve-table-column) last-column))) 225 | 226 | (defun sqlite-mode-extras-add-row () 227 | "Add a row to current table." 228 | (interactive) 229 | (let* ((type (sqlite-mode-extras--type-property-at-point)) 230 | (row (sqlite-mode-extras--row-property-at-point)) 231 | (table-name (cond ((and (consp type) 232 | (eq (car type) 'row)) 233 | (cdr type)) 234 | ((eq type 'table) 235 | (car row)))) 236 | (last-column (car (car (last (sqlite-mode-extras--table-header-column-details 237 | (sqlite-mode-extras--table-header-line))))))) 238 | (unless table-name 239 | (user-error "No table at point")) 240 | (sqlite-execute 241 | sqlite--db 242 | (format "INSERT INTO %s DEFAULT VALUES;" table-name)) 243 | (sqlite-mode-extras-refresh) 244 | (sqlite-mode-extras--end-of-table) 245 | (beginning-of-line) 246 | ;; Move to first non-id column. 247 | (while (and (not (sqlite-mode-extras--point-at-last-column-p)) 248 | (not (equal (sqlite-mode-extras--resolve-table-column) 249 | last-column)) 250 | (equal (sqlite-mode-extras--resolve-table-column) "id")) 251 | (sqlite-mode-extras-next-column)) 252 | (sqlite-mode-extras-edit-row-field))) 253 | 254 | (defun sqlite-mode-extras--type-property-at-point () 255 | "Get `sqlite--type property' at point." 256 | (save-excursion 257 | (if (and (eolp) (not (bolp))) 258 | (get-text-property (1- (point)) 'sqlite--type) 259 | (when (sqlite-mode-extras--on-table-header-p) 260 | (forward-line -1)) 261 | (get-text-property (point) 'sqlite--type)))) 262 | 263 | (defun sqlite-mode-extras--row-property-at-point () 264 | "Get `sqlite--row property' at point." 265 | (if (and (eolp) (not (bolp))) 266 | (get-text-property (1- (point)) 'sqlite--row) 267 | (get-text-property (point) 'sqlite--row))) 268 | 269 | (defun sqlite-mode-extras-ret-dwim () 270 | "DWIM binding for RET. 271 | 272 | If on table toggle expansion. If on row, edit it." 273 | (interactive) 274 | (if (and (eq (sqlite-mode-extras--type-property-at-point) 'table) 275 | (sqlite-mode-extras--row-property-at-point)) 276 | (sqlite-mode-list-data) 277 | (sqlite-mode-extras-edit-row-field))) 278 | 279 | (defun sqlite-mode-extras-tab-dwim (&optional backward) 280 | "DWIM binding for TAB. 281 | 282 | If on table toggle expansion. If on row, navigate to next field. 283 | 284 | When BACKWARD is set, navigate to previous field." 285 | (interactive) 286 | (cond ((and (eq (sqlite-mode-extras--type-property-at-point) 'table) 287 | (sqlite-mode-extras--row-property-at-point)) 288 | (sqlite-mode-list-data)) 289 | ((sqlite-mode-extras--on-select-query-p) 290 | (sqlite-mode-extras--toggle-query-results-display)) 291 | (t 292 | (sqlite-mode-extras-next-column backward)))) 293 | 294 | (defun sqlite-mode-extras-backtab-dwim () 295 | "Like `sqlite-mode-extras-tab-dwim' but backwards." 296 | (interactive) 297 | (sqlite-mode-extras-tab-dwim t)) 298 | 299 | (defun sqlite-mode-extras-next-column (&optional backward) 300 | "Navigate to next column. 301 | 302 | When BACKWARD is set, navigate to previous column." 303 | (interactive) 304 | (let* ((columns (sqlite-mode-extras--table-header-column-details 305 | (sqlite-mode-extras--table-header-line))) 306 | (next-column (seq-find (lambda (column) 307 | (let ((start (car (nth 1 column)))) 308 | (> start (current-column)))) 309 | columns)) 310 | (prev-column-index (if next-column 311 | (- (seq-position columns 312 | next-column) 2) 313 | (- (seq-position columns 314 | (car (last columns))) 1)))) 315 | (if backward 316 | (if (>= prev-column-index 0) 317 | (goto-char (+ (line-beginning-position) 318 | (car (nth 1 (nth prev-column-index columns))))) 319 | (forward-line -1) 320 | (goto-char (+ (line-beginning-position) 321 | (car (nth 1 (car (last columns))))))) 322 | (if next-column 323 | (goto-char (+ (line-beginning-position) 324 | (car (nth 1 next-column)))) 325 | (forward-line))))) 326 | 327 | (defun sqlite-mode-extras--row-field-value-at-point () 328 | "Get current row's field value." 329 | (when-let* ((columns (sqlite-mode-extras--table-header-column-details 330 | (sqlite-mode-extras--table-header-line))) 331 | (column (seq-find (lambda (column) 332 | (let ((start (car (nth 1 column))) 333 | (end (cdr (nth 1 column)))) 334 | (and (<= start (current-column)) 335 | (<= (current-column) end)))) 336 | columns)) 337 | (column-pos (seq-position columns column)) 338 | (row (sqlite-mode-extras--row-property-at-point))) 339 | (seq-elt row column-pos))) 340 | 341 | (defun sqlite-mode-extras--resolve-table-column () 342 | "Resolve point to relevant table column." 343 | (let* ((columns (sqlite-mode-extras--table-header-column-details 344 | (sqlite-mode-extras--table-header-line))) 345 | (column (seq-find (lambda (column) 346 | (let ((start (car (nth 1 column))) 347 | (end (cdr (nth 1 column)))) 348 | (and (<= start (current-column)) 349 | (<= (current-column) end)))) 350 | columns))) 351 | (or (seq-first column) 352 | ;; If at end of line, assume last column. 353 | (and (eolp) (not (bolp)) (car (car (last columns))))))) 354 | 355 | (defun sqlite-mode-extras--assert-on-row () 356 | "Ensure point is on a table row." 357 | (unless (sqlite-mode-extras--on-row-p) 358 | (user-error "No row under point"))) 359 | 360 | (defun sqlite-mode-extras--table-header-column-details (header) 361 | "Return column details list for HEADER string." 362 | (let ((leading-space (when (string-match "^ *" header) 363 | (match-string 0 header))) 364 | (start 0) 365 | columns) 366 | (with-temp-buffer 367 | (insert header) 368 | (goto-char 0) 369 | (while (re-search-forward "\\([^ ]+ *\\)" (point-max) t) 370 | (setq columns (append columns (list (match-string 0))))) 371 | (when (seq-first columns) 372 | (setcar columns 373 | (concat leading-space 374 | (seq-first columns)))) 375 | (mapcar (lambda (column) 376 | (let* ((next-start (+ start (length column))) 377 | (item (list (string-trim column) 378 | (cons start (1- next-start))))) 379 | (setq start next-start) 380 | item)) 381 | columns)))) 382 | 383 | (defun sqlite-mode-extras--end-of-table () 384 | "Go to end of current table." 385 | (when (eq (sqlite-mode-extras--type-property-at-point) 'table) 386 | (unless (sqlite-mode-extras--table-expanded-p) 387 | (user-error "Table must be expanded")) 388 | (forward-line 2)) 389 | (while (and (sqlite-mode-extras--on-row-p) 390 | (not (eobp))) 391 | (forward-line)) 392 | (forward-line -1)) 393 | 394 | (defmacro sqlite-mode-extras--save-excursion (&rest body) 395 | "Like `save-excursion' executing BODY, but line column based." 396 | (declare (indent 0) (debug t)) 397 | `(let ((current-line (if (region-active-p) 398 | (min (line-number-at-pos (region-beginning)) 399 | (line-number-at-pos (region-end))) 400 | (line-number-at-pos))) 401 | (current-line-column (current-column))) 402 | (unwind-protect 403 | (save-excursion ,@body) 404 | (forward-line (- current-line (line-number-at-pos))) 405 | (move-to-column current-line-column)))) 406 | 407 | (defun sqlite-mode-extras-refresh () 408 | "Refresh all listings and table queries." 409 | (interactive) 410 | (let ((expanded-tables (sqlite-mode-extras--expanded-tables)) 411 | (select-queries (sqlite-mode-extras--get-select-lines))) 412 | (sqlite-mode-extras--save-excursion 413 | (sqlite-mode-list-tables) 414 | (goto-char (point-min)) 415 | (while (not (eobp)) 416 | (when-let* ((table (sqlite-mode-extras--table-name)) 417 | (table-exists (seq-contains-p expanded-tables table))) 418 | (sqlite-mode-list-data)) 419 | (forward-line)) 420 | (mapc (lambda (query) 421 | (sqlite-mode-extras-execute-and-display-select-query query)) 422 | select-queries)))) 423 | 424 | (defun sqlite-mode-extras--expanded-tables () 425 | "Collect all the tables names that are expanded." 426 | (save-excursion 427 | (let ((tables)) 428 | (goto-char (point-min)) 429 | (while (not (eobp)) 430 | (when-let ((table (sqlite-mode-extras--table-name)) 431 | (table-exists (sqlite-mode-extras--table-expanded-p))) 432 | (push table tables)) 433 | (forward-line)) 434 | tables))) 435 | 436 | (defun sqlite-mode-extras--table-name () 437 | "Return table name at point." 438 | (when (eq (sqlite-mode-extras--type-property-at-point) 'table) 439 | (car (sqlite-mode-extras--row-property-at-point)))) 440 | 441 | (defun sqlite-mode-extras--table-expanded-p () 442 | "Return t if table at point is expanded." 443 | (save-excursion 444 | (forward-line) 445 | (sqlite-mode-extras--on-table-header-p))) 446 | 447 | (defun sqlite-mode-extras--on-table-p () 448 | "Return t if point is on table." 449 | (eq (sqlite-mode-extras--type-property-at-point) 'table)) 450 | 451 | (defun sqlite-mode-extras--toggle-query-results-display (&optional remove) 452 | "Toggle query results display. 453 | 454 | Set REMOVE to remove query and results." 455 | (unless (sqlite-mode-extras--on-select-query-p) 456 | (error "Not on a select query")) 457 | (let ((query) 458 | (inhibit-read-only t)) 459 | (save-excursion 460 | (forward-line 2) 461 | (if (looking-at " ") 462 | ;; Delete results + newline. 463 | (progn 464 | (delete-region (point) (if (re-search-forward "^[^ ]" nil t) 465 | (match-beginning 0) 466 | (point-max))) 467 | (forward-line -1) 468 | (delete-line) 469 | (when remove 470 | (forward-line -1) 471 | (delete-line))) 472 | (setq query (thing-at-point 'line t)) 473 | (forward-line -1) 474 | (delete-line) 475 | (unless remove 476 | (sqlite-mode-extras-execute-and-display-select-query query t)))))) 477 | 478 | (defun sqlite-mode-extras--on-select-query-p () 479 | "Return t if on SELECT statement." 480 | (save-excursion 481 | (beginning-of-line) 482 | (looking-at (rx bol (or "SELECT" "select") (1+ space))))) 483 | 484 | (defun sqlite-mode-extras--on-row-p () 485 | "Look for line above with \='header-line\= face." 486 | (when (consp (sqlite-mode-extras--type-property-at-point)) 487 | (eq (car (sqlite-mode-extras--type-property-at-point)) 'row))) 488 | 489 | 490 | (defun sqlite-mode-extras--on-table-header-p () 491 | "Return t if on table header." 492 | (eq 'header-line 493 | (get-text-property 0 'face 494 | (replace-regexp-in-string 495 | "\\s-" "" (thing-at-point 'line))))) 496 | 497 | (defun sqlite-mode-extras--table-header-line () 498 | "Look for line above with \='header-line\= face." 499 | (save-excursion 500 | (goto-char (sqlite-mode-extras--table-header-pos)) 501 | (thing-at-point 'line t))) 502 | 503 | (defun sqlite-mode-extras--table-header-pos () 504 | "Look for line above with \='header-line\= face." 505 | (let ((pos)) 506 | (if (and (eq (sqlite-mode-extras--type-property-at-point) 'table) 507 | (sqlite-mode-extras--table-expanded-p)) 508 | (save-excursion 509 | (forward-line) 510 | (setq pos (line-beginning-position))) 511 | (save-excursion 512 | (while (and (not pos) (not (bobp))) 513 | (when (and (thing-at-point 'line) 514 | (eq 'header-line 515 | (get-text-property 0 'face 516 | (replace-regexp-in-string 517 | "\\s-" "" (thing-at-point 'line))))) 518 | (setq pos (line-beginning-position))) 519 | (forward-line -1)))) 520 | (unless pos 521 | (user-error "No table header found")) 522 | pos)) 523 | 524 | (defun sqlite-mode-extras--selected-table-name-in-query (query) 525 | "Extract table name from sqlite SELECT QUERY." 526 | (when (string-match-p (rx bol (or "SELECT" "select") (1+ space)) (downcase query)) 527 | (let* ((words (split-string query)) 528 | (from-index (cl-position "from" words :test #'string= :key #'downcase))) 529 | (when from-index 530 | (when-let ((table-name (nth (1+ from-index) words))) 531 | (replace-regexp-in-string "[^a-zA-Z0-9_]" "" table-name)))))) 532 | 533 | (defun sqlite-mode-extras-execute-and-display-select-query (&optional query insert-at-point) 534 | "Execute a SELECT QUERY. 535 | 536 | Set INSERT-AT-POINT to insert all results at point (instead of (point-max))" 537 | (interactive) 538 | (let* ((query (or query (read-string "Query: " "SELECT * from "))) 539 | (table (sqlite-mode-extras--selected-table-name-in-query query)) 540 | (rowid 0) 541 | (inhibit-read-only t) 542 | stmt) 543 | (unless table 544 | (user-error "No table name found in SELECT query")) 545 | (unwind-protect 546 | (progn 547 | (setq stmt 548 | (sqlite-select 549 | sqlite--db 550 | query 551 | nil 552 | 'set)) 553 | (unless insert-at-point 554 | (goto-char (point-max)) 555 | (insert "\n")) 556 | (save-excursion 557 | (insert (propertize (format "%s\n\n" (string-trim query)) 'face 'font-lock-doc-face)) 558 | (sqlite-mode--tablify (sqlite-columns stmt) 559 | (cl-loop for i from 0 upto 1000 560 | for row = (sqlite-next stmt) 561 | while row 562 | do (setq rowid (car row)) 563 | collect row) 564 | (cons 'row table) 565 | " ") 566 | (when (sqlite-more-p stmt) 567 | (insert (buttonize " More data...\n" #'sqlite-mode--more-data 568 | (list table rowid)))))) 569 | (when stmt 570 | (sqlite-finalize stmt))))) 571 | 572 | (defun sqlite-mode-extras--get-select-lines () 573 | "Get all lines starting with SELECT or select from the current buffer." 574 | (save-excursion 575 | (goto-char (point-min)) 576 | (let ((regexp (rx bol (0+ space) (or "SELECT" "select") (one-or-more any))) 577 | (matches)) 578 | (while (re-search-forward regexp nil t) 579 | (push (string-trim (match-string 0)) matches)) 580 | (reverse matches)))) 581 | 582 | (defvar-keymap sqlite-extras-minor-mode-map 583 | :doc "Keymap for `sqlite-extras-minor-mode'." 584 | "n" #'next-line 585 | "p" #'previous-line 586 | "b" #'sqlite-mode-extras-backtab-dwim 587 | "f" #'sqlite-mode-extras-tab-dwim 588 | "+" #'sqlite-mode-extras-add-row 589 | "D" #'sqlite-mode-extras-delete-row-dwim 590 | "C" #'sqlite-mode-extras-compose-and-execute 591 | "E" #'sqlite-mode-extras-execute 592 | "S" #'sqlite-mode-extras-execute-and-display-select-query 593 | "DEL" #'sqlite-mode-extras-delete-row-dwim 594 | "g" #'sqlite-mode-extras-refresh 595 | "" #'sqlite-mode-extras-backtab-dwim 596 | "" #'sqlite-mode-extras-tab-dwim 597 | "RET" #'sqlite-mode-extras-ret-dwim) 598 | 599 | (define-minor-mode sqlite-extras-minor-mode 600 | "Enable bindings for SQLite Extras." 601 | :keymap sqlite-extras-minor-mode-map 602 | :interactive (sqlite-mode) 603 | (when (and sqlite-extras-minor-mode 604 | (not (derived-mode-p 'sqlite-mode))) 605 | (setq-local sqlite-extras-minor-mode nil))) 606 | 607 | (provide 'sqlite-mode-extras) 608 | ;;; sqlite-mode-extras.el ends here 609 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------