├── .gitignore ├── README.md ├── LICENSE-apache ├── gleam-ts-mode.el └── LICENSE-gpl /.gitignore: -------------------------------------------------------------------------------- 1 | # Identifies files to be ignored by Git. 2 | # Also used by fd|fdfind to identify directories and files to ignore 3 | 4 | # Byte-Compiled Emacs Lisp files 5 | *.elc 6 | 7 | # Emacs Backup files 8 | *~ 9 | # Emacs temporary files 10 | .#* 11 | *# 12 | \#* 13 | 14 | # ---------------------------------------------------------------------------- 15 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | gleam-ts-mode: An Emacs Major Mode for [Gleam] 2 | ============================================== 3 | 4 | [![MELPA](https://melpa.org/packages/gleam-ts-mode-badge.svg)](https://melpa.org/#/gleam-ts-mode) 5 | 6 | This mode uses [tree-sitter] (and Emacs 29's `treesit` package) under-the-hood for syntax highlighting and code navigation. If you're using an Emacs that's older than 29 (run `M-x version` to find out), or a version compiled without `treesit` (run `M-: (treesit-available-p)` to find out), you probably want [gleam-mode] instead. 7 | 8 | https://user-images.githubusercontent.com/2058614/151681785-5d212e1b-191b-4e7d-a868-f6e42d7efe61.mp4 9 | 10 | Setup 11 | ----- 12 | 13 | This project is hosted on [MELPA], and this is the recommended way to install the package. To add MELPA as a package repository, add the following to your Emacs init file: 14 | ```elisp 15 | (require 'package) 16 | ;; Add MELPA to archives 17 | (add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/")) 18 | ;; Load and activate packages 19 | (package-initialize) 20 | ``` 21 | 22 | ### use-package (recommended) 23 | 24 | Add the following to your Emacs init file: 25 | ```elisp 26 | (use-package gleam-ts-mode 27 | :mode (rx ".gleam" eos)) 28 | ``` 29 | 30 | ### vanilla 31 | 32 | Install with 33 | ``` 34 | M-x package-install RET gleam-ts-mode RET 35 | ``` 36 | (`M-x` stands for "meta + x" which indicates holding the meta key (usually labeled "Alt") and tapping "x". Where you see `RET` you should press your "Enter" or "Return" key). 37 | 38 | To load the package, run the following (or place it in your Emacs init file): 39 | ```elisp 40 | (require 'gleam-ts-mode) 41 | (add-to-list 'auto-mode-alist '("\\.gleam\\'" . gleam-ts-mode)) 42 | ``` 43 | 44 | ### Install the Tree-Sitter Grammar 45 | 46 | Unless you have the Gleam tree-sitter grammar installed and treesit knows where to find it, you'll want to run `M-x gleam-ts-install-grammar`. It should only take a moment, but does require that your OS has a C compiler available. 47 | 48 | ### For Doom-Emacs Users 49 | 50 | add this in your 'packages.el' file: 51 | ```elisp 52 | (package! gleam-ts-mode 53 | :recipe (:host github 54 | :repo "gleam-lang/gleam-mode" 55 | :branch "main" 56 | 57 | :files ("gleam-ts-*.el"))) 58 | ``` 59 | add this to your 'config.el' file: 60 | ```elisp 61 | (use-package! gleam-ts-mode 62 | :mode (rx ".gleam" eos)) 63 | 64 | (after! treesit 65 | (add-to-list 'auto-mode-alist '("\\.gleam$" . gleam-ts-mode))) 66 | 67 | (after! gleam-ts-mode 68 | (unless (treesit-language-available-p 'gleam) 69 | (gleam-ts-install-grammar))) 70 | ``` 71 | 72 | TODO 73 | ---- 74 | 75 | - [x] Syntax highlighting 76 | - [x] Indentation 77 | - [x] Imenu integration 78 | - [x] Formatting 79 | - [ ] Completion? 80 | - [ ] REPL? 81 | 82 | Looking for the old gleam-mode? 83 | ------------------------------- 84 | 85 | gleam-mode is deprecated and removed in favor of gleam-ts-mode. However, if you still need gleam-mode for some reason, you can find it [in the git history](https://github.com/gleam-lang/gleam-mode/blob/8656c4080dd2bb7dd6d6167953d6463d090509b0/gleam-mode.el) 86 | 87 | [gleam-mode]: https://github.com/gleam-lang/gleam-mode/blob/8656c4080dd2bb7dd6d6167953d6463d090509b0/gleam-mode.el 88 | -------------------------------------------------------------------------------- /LICENSE-apache: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /gleam-ts-mode.el: -------------------------------------------------------------------------------- 1 | ;;; gleam-ts-mode.el --- Major mode for Gleam -*- lexical-binding: t -*- 2 | 3 | ;; Copyright © 2024 Louis Pilfold 4 | ;; Authors: Jonathan Arnett 5 | ;; 6 | ;; URL: https://github.com/gleam-lang/gleam-mode 7 | ;; Keywords: languages gleam 8 | ;; Version: 0.1.0 9 | ;; SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later 10 | ;; Package-Requires: ((emacs "29.1")) 11 | 12 | ;; This file is NOT part of GNU Emacs. 13 | 14 | ;; This program is licensed under The Apache License¹, Version 2.0 or, 15 | ;; at your option, under the terms of the GNU General Public License² 16 | ;; as published by the Free Software Foundation, version 3, or 17 | ;; (at your option) any later version. 18 | 19 | ;; ¹ You may not use this file except in compliance with the License. 20 | ;; You may obtain a copy of the License at 21 | ;; 22 | ;; http://www.apache.org/licenses/LICENSE-2.0 23 | ;; 24 | ;; Unless required by applicable law or agreed to in writing, software 25 | ;; distributed under the License is distributed on an "AS IS" BASIS, 26 | ;; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 27 | ;; See the License for the specific language governing permissions and 28 | ;; limitations under the License. 29 | 30 | ;; ² This program is distributed in the hope that it will be useful, 31 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 32 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 33 | ;; General Public License for more details. 34 | ;; 35 | ;; You should have received a copy of the GNU General Public License 36 | ;; along with this package. If not, see https://www.gnu.org/licenses. 37 | 38 | ;;; Commentary: 39 | 40 | ;; Provides syntax highlighting, indentation, and code navigation 41 | ;; features for the Gleam programming language. 42 | 43 | ;;; Code: 44 | 45 | (require 'prog-mode) 46 | (require 'treesit) 47 | 48 | 49 | ;;; Customization 50 | 51 | (defgroup gleam-ts nil 52 | "Major mode for editing Gleam." 53 | :prefix "gleam-ts-" 54 | :group 'languages) 55 | 56 | (defcustom gleam-ts-indent-offset 2 57 | "Offset used to indent Gleam code." 58 | :type 'integer 59 | :safe 'integerp 60 | :group 'gleam-ts) 61 | 62 | (defcustom gleam-ts-gleam-executable "gleam" 63 | "Name of the gleam cli command with or without absolute path. 64 | Specify the absolute path to gleam if it is not in your PATH." 65 | :type 'file 66 | :group 'gleam-ts) 67 | 68 | (defcustom gleam-ts-format-on-save nil 69 | "Activate execution of gleam format on file save when non-nil. 70 | A change to this setting only takes effect the next time the 71 | `gleam-ts-mode' executes." 72 | :type 'boolean 73 | :safe #'booleanp 74 | :group 'gleam-ts) 75 | 76 | ;;; Tree-sitter font locking 77 | 78 | (defface gleam-ts-constructor-face 79 | '((t (:inherit font-lock-type-face))) 80 | "Font used for highlighting Gleam type constructors.") 81 | 82 | (defface gleam-ts-module-face 83 | '((t (:inherit font-lock-variable-name-face))) 84 | "Font used for highlighting Gleam modules.") 85 | 86 | (defvar gleam-ts--grammar-revision 87 | (if (and (treesit-available-p) (< (treesit-library-abi-version) 15)) 88 | "v1.0.0" 89 | "main") 90 | "Treesitter grammar (gleam-lang/tree-sitter-gleam repo) revision.") 91 | 92 | (defun gleam-ts--grammar-supports-echo-keyword-p () 93 | "Determines whether grammar library version supports the `echo' keyword." 94 | (let ((version-p (string-match-p "^v?[0-9]+\\(\\.[0-9]+\\)*$" gleam-ts--grammar-revision))) 95 | (if version-p 96 | (let ((version (string-trim-left gleam-ts--grammar-revision "v"))) 97 | (not (version< version "1.1.0"))) 98 | t))) 99 | 100 | (defvar gleam-ts--font-lock-settings 101 | (treesit-font-lock-rules 102 | :feature 'comment 103 | :language 'gleam 104 | '((comment) @font-lock-comment-face) 105 | 106 | :feature 'string 107 | :language 'gleam 108 | '((string) @font-lock-string-face) 109 | 110 | :feature 'number 111 | :language 'gleam 112 | '((integer) @font-lock-number-face 113 | (float) @font-lock-number-face) 114 | 115 | :feature 'function-name 116 | :language 'gleam 117 | '((unqualified_import (identifier) @font-lock-function-name-face) 118 | (function 119 | name: (identifier) @font-lock-function-name-face) 120 | (external_function 121 | name: (identifier) @font-lock-function-name-face)) 122 | 123 | :feature 'function-use 124 | :language 'gleam 125 | '((function_call function: (identifier) @font-lock-function-call-face) 126 | (function_call 127 | function: (field_access record: (identifier) field: (label) @font-lock-function-call-face))) 128 | 129 | :feature 'variable-name 130 | :language 'gleam 131 | '((identifier) @font-lock-variable-name-face) 132 | 133 | :feature 'constructor 134 | :language 'gleam 135 | '((unqualified_import (type_identifier) @gleam-ts-constructor-face) 136 | (constructor_name) @gleam-ts-constructor-face) 137 | 138 | :feature 'type-name 139 | :language 'gleam 140 | '((unqualified_import "type" (type_identifier) @font-lock-type-face) 141 | (remote_type_identifier) @font-lock-type-face 142 | (type_identifier) @font-lock-type-face) 143 | 144 | :language 'gleam 145 | :feature 'type-use 146 | '(((record name: (constructor_name) @font-lock-type-face)) 147 | ((record_pattern name: (constructor_name) @font-lock-type-face)) 148 | ((data_constructor name: (constructor_name) @font-lock-type-face)) 149 | ((remote_constructor_name name: (constructor_name) @font-lock-type-face)) 150 | ((record_update constructor: (constructor_name) @font-lock-type-face))) 151 | 152 | :feature 'constant-name 153 | :language 'gleam 154 | :override t 155 | '((constant 156 | name: (identifier) @font-lock-constant-face)) 157 | 158 | :feature 'keyword 159 | :language 'gleam 160 | (let* ((basic-keywords 161 | [ 162 | (visibility_modifier) 163 | (opacity_modifier) 164 | "as" 165 | "assert" 166 | "case" 167 | "const" 168 | ;; Deprecated 169 | "external" 170 | "fn" 171 | "if" 172 | "import" 173 | "let" 174 | "panic" 175 | "todo" 176 | "type" 177 | "use" 178 | ]) 179 | (keywords (if (gleam-ts--grammar-supports-echo-keyword-p) 180 | (vconcat basic-keywords ["echo"]) 181 | basic-keywords))) 182 | (list keywords '@font-lock-keyword-face)) 183 | 184 | :feature 'operator 185 | :language 'gleam 186 | '((binary_expression operator: _ @font-lock-operator-face) 187 | (boolean_negation "!" @operator) 188 | (integer_negation "-" @operator)) 189 | 190 | :feature 'property 191 | :language 'gleam 192 | '((data_constructor_argument label: (label) @font-lock-property-name-face)) 193 | 194 | :feature 'property-use 195 | :language 'gleam 196 | '((field_access record: (identifier) field: (label) @font-lock-property-use-face) 197 | (tuple_access index: (integer) @font-lock-property-use-face)) 198 | 199 | :feature 'annotation 200 | :language 'gleam 201 | :override t 202 | '((attribute 203 | "@" @font-lock-preprocessor-face 204 | name: (identifier) @font-lock-preprocessor-face)) 205 | 206 | :feature 'documentation 207 | :language 'gleam 208 | '((module_comment) @font-lock-doc-face 209 | (statement_comment) @font-lock-doc-face) 210 | 211 | :feature 'module 212 | :language 'gleam 213 | :override t 214 | '((module) @gleam-ts-module-face 215 | (import alias: (identifier) @gleam-ts-module-face) 216 | (remote_type_identifier 217 | module: (identifier) @gleam-ts-module-face)) 218 | 219 | :feature 'builtin 220 | :language 'gleam 221 | :override t 222 | '((bit_string_segment_option) @font-lock-builtin-face) 223 | 224 | :feature 'bracket 225 | :language 'gleam 226 | '([ 227 | "(" 228 | ")" 229 | "[" 230 | "]" 231 | "{" 232 | "}" 233 | "<<" 234 | ">>" 235 | ] @font-lock-bracket-face) 236 | 237 | :feature 'delimiter 238 | :language 'gleam 239 | '([ 240 | "." 241 | "," 242 | ;; Controversial -- maybe some are operators? 243 | ":" 244 | "#" 245 | "=" 246 | "->" 247 | ".." 248 | "-" 249 | "<-" 250 | ] @font-lock-delimiter-face))) 251 | 252 | (defvar gleam-ts--indent-rules 253 | (let ((offset 'gleam-ts-indent-offset)) 254 | `((gleam 255 | ((node-is "^source_file$") column-0 0) 256 | ((node-is "^import$") parent-bol 0) 257 | ;; We should indent any child node of unqualified_imports UNLESS it's `}' 258 | ((match "^}$" "^unqualified_imports$") parent-bol 0) 259 | ((parent-is "^unqualified_imports$") parent-bol ,offset) 260 | ((node-is "^constant$") parent-bol 0) 261 | ((parent-is "^constant$") parent-bol ,offset) 262 | ((parent-is "^constant_tuple_type$") parent-bol ,offset) 263 | ((parent-is "^type_arguments$") parent-bol ,offset) 264 | ((node-is "^external_type$") parent-bol 0) 265 | ((parent-is "^external_type$") parent-bol ,offset) 266 | ((node-is "^external_function$") parent-bol 0) 267 | ((parent-is "^external_function$") parent-bol ,offset) 268 | ((node-is "^type_definition$") parent-bol 0) 269 | ((node-is "^type_alias$") parent-bol 0) 270 | ((node-is "^attribute$") parent-bol 0) 271 | ((node-is "^attribute_value$") parent-bol ,offset) 272 | ((node-is "^module-comment$") parent-bol 0) 273 | ((node-is "^statement_comment$") parent-bol 0) 274 | ((node-is "^comment$") parent-bol 0) 275 | ((node-is "^}$") parent-bol 0) 276 | ((node-is "^]$") parent-bol 0) 277 | ((node-is "^)$") parent-bol 0) 278 | ((node-is "^>>$") parent-bol 0) 279 | ((node-is "^function$") parent-bol 0) 280 | ((parent-is "^type_definition$") parent-bol ,offset) 281 | ((parent-is "^function$") parent-bol ,offset) 282 | ((parent-is "^anonymous_function$") parent-bol ,offset) 283 | ((parent-is "^block$") parent-bol ,offset) 284 | ((parent-is "^function_parameters$") parent-bol ,offset) 285 | ((parent-is "^function_parameter_types$") parent-bol ,offset) 286 | ((parent-is "^arguments$") parent-bol ,offset) 287 | ((parent-is "^case$") parent-bol ,offset) 288 | ((node-is "^case_clause$") gleam-ts--grand-parent-bol ,offset) 289 | ((parent-is "^case_clause$") parent-bol ,offset) 290 | ((parent-is "^record_pattern_arguments$") parent-bol ,offset) 291 | ((node-is "^|>$") parent-bol gleam-ts--pipe-indent-offset) 292 | ((parent-is "^binary_expression$") parent-bol ,offset) 293 | ((parent-is "^todo$") parent-bol ,offset) 294 | ((parent-is "^panic$") parent-bol ,offset) 295 | ((parent-is "^tuple$") parent-bol ,offset) 296 | ((parent-is "^list$") parent-bol ,offset) 297 | ((parent-is "^let$") parent-bol ,offset) 298 | ((parent-is "^let_assert$") parent-bol ,offset) 299 | ((parent-is "^bit_string$") parent-bol ,offset))))) 300 | 301 | (defun gleam-ts--grand-parent-bol (_n parent &rest _) 302 | "Return the beginning of line for the PARENT's parent's parent." 303 | (save-excursion 304 | (goto-char (treesit-node-start (treesit-node-parent parent))) 305 | (back-to-indentation) 306 | (point))) 307 | 308 | (defun gleam-ts--pipe-indent-offset (_n parent &rest _) 309 | "Return the indentation offset for the given pipeline NODE and its PARENT. 310 | 311 | If the pipeline's initial expression is in a multi-element list or a 312 | multi-argument function call, the indentation increases by one level; 313 | otherwise, it aligns with the initial expression." 314 | (let ((top-level 315 | (treesit-node-parent 316 | (treesit-parent-while 317 | parent 318 | (lambda (node) (equal (treesit-node-type node) "binary_expression")))))) 319 | (cond 320 | ;; Indent if pipeline is within multiple function arguments. 321 | ((and 322 | (equal (treesit-node-type top-level) "argument") 323 | (> (treesit-node-child-count (treesit-node-parent top-level) "argument") 1)) 324 | gleam-ts-indent-offset) 325 | 326 | ;; Indent if pipeline is in a list with multiple elements. 327 | ((and 328 | (equal (treesit-node-type top-level) "list") 329 | (> (treesit-node-child-count top-level "binary_expression") 1)) 330 | gleam-ts-indent-offset) 331 | 332 | ;; Otherwise, align with the initial expression. 333 | (t 0)))) 334 | 335 | 336 | ;;; Public functions 337 | 338 | ;;;###autoload 339 | (defun gleam-ts-install-grammar () 340 | "Install the Gleam tree-sitter grammar." 341 | (interactive) 342 | (if (and (treesit-available-p) (boundp 'treesit-language-source-alist)) 343 | (let* ((language-source (list "https://github.com/gleam-lang/tree-sitter-gleam" gleam-ts--grammar-revision)) 344 | (treesit-language-source-alist 345 | (cons 346 | (cons 'gleam language-source) 347 | treesit-language-source-alist))) 348 | (treesit-install-language-grammar 'gleam)) 349 | (display-warning 'treesit "Emacs' treesit package does not appear to be available"))) 350 | 351 | ;;;###autoload 352 | (defun gleam-ts-format () 353 | "Format the current buffer using the `gleam format' command." 354 | (interactive) 355 | (if (executable-find gleam-ts-gleam-executable) 356 | (save-restriction ; Save the user's narrowing, if any 357 | (widen) ; Expand scope to the whole, unnarrowed buffer 358 | (let* ((buf (current-buffer)) 359 | (min (point-min)) 360 | (max (point-max)) 361 | (tmpfile (make-nearby-temp-file "gleam-format"))) 362 | (unwind-protect 363 | (with-temp-buffer 364 | (insert-buffer-substring-no-properties buf min max) 365 | (write-file tmpfile) 366 | (call-process gleam-ts-gleam-executable 367 | nil nil nil "format" (buffer-file-name)) 368 | (revert-buffer :ignore-autosave :noconfirm) 369 | (let ((tmpbuf (current-buffer))) 370 | (with-current-buffer buf 371 | (replace-buffer-contents tmpbuf)))) 372 | (if (file-exists-p tmpfile) (delete-file tmpfile))) 373 | (message "Formatted!"))) 374 | (user-error "gleam executable (%s) not found! 375 | Please update `gleam-ts-gleam-executable' customizable user-option" 376 | gleam-ts-gleam-executable))) 377 | 378 | 379 | ;;; Private functions 380 | (defun gleam-ts--public (node) 381 | "Determine whether NODE is public." 382 | (treesit-filter-child 383 | node 384 | (lambda (child) (equal (treesit-node-type child) "visibility_modifier")))) 385 | 386 | (defun gleam-ts--private (node) 387 | "Determine whether NODE is private." 388 | (not (gleam-ts--public node))) 389 | 390 | (defun gleam-ts--opaque (node) 391 | "Determine whether NODE is opaque." 392 | (treesit-filter-child 393 | node 394 | (lambda (child) (equal (treesit-node-type child) "opacity_modifier")))) 395 | 396 | (defun gleam-ts--transparent (node) 397 | "Determine whether NODE is /not/ opaque (i.e. transparent)." 398 | (not (gleam-ts--opaque node))) 399 | 400 | (defun gleam-ts--external-fun (node) 401 | "Determine whether function NODE is external." 402 | (not (treesit-node-child-by-field-name node "body"))) 403 | 404 | (defun gleam-ts--internal-fun (node) 405 | "Determine whether function NODE is internal to Gleam." 406 | (not (gleam-ts--external-fun node))) 407 | 408 | (defun gleam-ts--constant-name (node) 409 | "Retrieve the name from a constant NODE." 410 | (treesit-node-text (treesit-node-child-by-field-name node "name"))) 411 | 412 | (defun gleam-ts--function-name (node) 413 | "Retrieve the name from a function NODE." 414 | (treesit-node-text (treesit-node-child-by-field-name node "name"))) 415 | 416 | (defun gleam-ts--type-name (node) 417 | "Retrieve the name from a type NODE." 418 | (treesit-node-text 419 | (car 420 | (treesit-filter-child 421 | node 422 | (lambda (child) (equal (treesit-node-type child) "type_name")))))) 423 | 424 | 425 | ;;; Major mode definition 426 | ;;;###autoload 427 | (define-derived-mode gleam-ts-mode prog-mode "Gleam" 428 | "Major mode for editing Gleam. 429 | 430 | \\" 431 | :group 'gleam-ts 432 | 433 | (cond 434 | ((treesit-ready-p 'gleam) 435 | (treesit-parser-create 'gleam) 436 | 437 | (setq-local treesit-font-lock-settings gleam-ts--font-lock-settings) 438 | (setq-local treesit-font-lock-feature-list 439 | '((comment string number function-name variable-name constructor type-name) 440 | (constant-name keyword operator property) 441 | (annotation documentation module builtin bracket delimiter) 442 | (function-use property-use type-use))) 443 | 444 | (setq-local treesit-simple-indent-rules gleam-ts--indent-rules) 445 | 446 | (setq-local treesit-simple-imenu-settings 447 | '(("Public Functions" "^function$" (lambda (fun) (and (gleam-ts--public fun) (gleam-ts--internal-fun fun))) gleam-ts--function-name) 448 | ("Public Types" "^type_definition" (lambda (type) (and (gleam-ts--public type) (gleam-ts--transparent type))) gleam-ts--type-name) 449 | ("Public Type Alias" "^type_alias" gleam-ts--public gleam-ts--type-name) 450 | ("Public Opaque Types" "^type_definition" (lambda (type) (and (gleam-ts--public type) (gleam-ts--opaque type))) gleam-ts--type-name) 451 | ("Public Constants" "^constant$" gleam-ts--public gleam-ts--constant-name) 452 | ("Public External Functions" "^function$" (lambda (fun) (and (gleam-ts--public fun) (gleam-ts--external-fun fun))) gleam-ts--function-name) 453 | ("Public External Types" "^external_type" gleam-ts--public gleam-ts--type-name) 454 | ("Private Functions" "^function$" gleam-ts--private gleam-ts--function-name) 455 | ("Private Types" "^type_definition" gleam-ts--private gleam-ts--type-name) 456 | ("Private Type Alias" "^type_alias" gleam-ts--private gleam-ts--type-name) 457 | ("Private Constants" "^constant$" gleam-ts--private gleam-ts--constant-name) 458 | ("Private External Functions" "^todo" (lambda (fun) (and (gleam-ts--private fun) (gleam-ts--external-fun fun))) gleam-ts--function-name) 459 | ("Private External Types" "^external_type" gleam-ts--private gleam-ts--type-name))) 460 | 461 | (setq-local treesit-defun-type-regexp (rx bol (or "type_definition" 462 | "type_alias" 463 | "function") 464 | eol)) 465 | 466 | (setq-local comment-start "// ") 467 | (setq-local comment-start-skip (rx "/" (+ "/") (* (syntax whitespace)))) 468 | (setq-local comment-end "") 469 | (setq-local comment-end-skip 470 | (rx (* (syntax whitespace)) 471 | (group (or (syntax comment-end) "\n")))) 472 | 473 | ;; Activate format on save if requested by customization. 474 | (when gleam-ts-format-on-save 475 | (add-hook 'before-save-hook #'gleam-ts-format nil 'local)) 476 | 477 | (treesit-major-mode-setup)) 478 | (t 479 | (message "Cannot load tree-sitter-gleam. Try running `gleam-ts-install-grammar' and report a bug if the issue reoccurs.")))) 480 | 481 | (provide 'gleam-ts-mode) 482 | ;;; gleam-ts-mode.el ends here 483 | -------------------------------------------------------------------------------- /LICENSE-gpl: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------