├── .gitignore ├── .github ├── dependabot.yml └── workflows │ └── main.yml ├── Eask ├── run_tests.sh ├── README.md ├── test └── zig-tests.el ├── zig-mode.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | 3 | # build tools 4 | .eask/ 5 | dist/ 6 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: github-actions 4 | directory: / 5 | schedule: 6 | interval: daily 7 | -------------------------------------------------------------------------------- /Eask: -------------------------------------------------------------------------------- 1 | ;; -*- mode: eask; lexical-binding: t -*- 2 | 3 | (package "zig-mode" 4 | "0.0.8" 5 | "A major mode for the Zig programming language") 6 | 7 | (website-url "https://github.com/zig-lang/zig-mode") 8 | (keywords "zig" "languages") 9 | 10 | (package-file "zig-mode.el") 11 | 12 | (script "test" "echo \"Error: no test specified\" && exit 1") 13 | 14 | (source 'gnu) 15 | (source 'melpa) 16 | 17 | (depends-on "emacs" "26.1") 18 | (depends-on "reformatter") 19 | 20 | (setq network-security-level 'low) ; see https://github.com/jcs090218/setup-emacs-windows/issues/156#issuecomment-932956432 21 | -------------------------------------------------------------------------------- /run_tests.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ -z "${EMACS}" ]; then 4 | EMACS="emacs" 5 | else 6 | echo "Running with EMACS=${EMACS}" 7 | fi 8 | 9 | # From https://github.com/jcollard/elm-mode/blob/master/Makefile 10 | NEEDED_PACKAGES="reformatter" 11 | INIT_PACKAGES="(progn \ 12 | (require 'package) \ 13 | (push '(\"melpa\" . \"https://melpa.org/packages/\") package-archives) \ 14 | (package-initialize) \ 15 | (dolist (pkg '(${NEEDED_PACKAGES})) \ 16 | (unless (package-installed-p pkg) \ 17 | (unless (assoc pkg package-archive-contents) \ 18 | (package-refresh-contents)) \ 19 | (package-install pkg))) \ 20 | )" 21 | 22 | "${EMACS}" --eval "${INIT_PACKAGES}" --batch -l zig-mode.el -l test/zig-tests.el -f ert-run-tests-batch-and-exit 23 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | workflow_dispatch: 9 | 10 | concurrency: 11 | group: ${{ github.workflow }}-${{ github.ref }} 12 | cancel-in-progress: true 13 | 14 | jobs: 15 | build: 16 | runs-on: ${{ matrix.os }} 17 | continue-on-error: ${{ matrix.experimental }} 18 | strategy: 19 | fail-fast: false 20 | matrix: 21 | os: [ubuntu-latest, macos-latest, windows-latest] 22 | emacs-version: 23 | - 26.3 24 | - 27.2 25 | - 28.2 26 | - 29.4 27 | - 30.2 28 | experimental: [false] 29 | include: 30 | - os: ubuntu-latest 31 | emacs-version: snapshot 32 | experimental: true 33 | - os: macos-latest 34 | emacs-version: snapshot 35 | experimental: true 36 | exclude: 37 | - os: macos-latest 38 | emacs-version: 26.3 39 | - os: macos-latest 40 | emacs-version: 27.2 41 | 42 | steps: 43 | - uses: jcs090218/setup-emacs@master 44 | with: 45 | version: ${{ matrix.emacs-version }} 46 | 47 | - uses: emacs-eask/setup-eask@master 48 | with: 49 | version: 'snapshot' 50 | 51 | - uses: actions/checkout@v6 52 | 53 | - name: Run tests 54 | run: | 55 | eask install-deps 56 | eask package 57 | eask install 58 | eask compile 59 | eask test ert ./test/*.el 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # zig-mode 2 | 3 | Syntax highlighting and automatic indentation for the [Zig programming 4 | language](http://ziglang.org) in Emacs. Requires Emacs 24.3 or later. 5 | 6 | ## Installation 7 | 8 | [![NonGNU ELPA](https://elpa.nongnu.org/nongnu/zig-mode.svg)](https://elpa.nongnu.org/nongnu/zig-mode.html) 9 | [![MELPA](https://melpa.org/packages/zig-mode-badge.svg)](https://melpa.org/#/zig-mode) 10 | 11 | Simply install the `zig-mode` package via [NonGNU ELPA](https://elpa.nongnu.org/) or 12 | [MELPA](https://melpa.org/#/getting-started). 13 | 14 | ### Manual install 15 | 16 | Alternatively, you can `git clone` the `zig-mode` repository somewhere 17 | (e.g. under your `~/.emacs.d/`). `zig-mode` depends on 18 | [reformatter](https://github.com/purcell/emacs-reformatter) for 19 | formatting buffers with `zig fmt`. 20 | 21 | `reformatter` can be installed from MELPA or installed manually in a 22 | similar fashion to `zig-mode`. For this method, clone the 23 | `reformatter` git repository and add the path to the repository to 24 | your `load-path`. 25 | 26 | Then add the following to your `.emacs` file: 27 | 28 | ```elisp 29 | (unless (version< emacs-version "24") 30 | (add-to-list 'load-path "~/path/to/your/zig-mode/") 31 | (autoload 'zig-mode "zig-mode" nil t) 32 | (add-to-list 'auto-mode-alist '("\\.\\(zig\\|zon\\)\\'" . zig-mode)) 33 | ``` 34 | 35 | ## Testing 36 | 37 | [![CI](https://github.com/ziglang/zig-mode/actions/workflows/main.yml/badge.svg)](https://github.com/ziglang/zig-mode/actions/workflows/main.yml) 38 | 39 | To run the test locally, you will need the following tools: 40 | 41 | - [Eask](https://emacs-eask.github.io/) 42 | - [Make](https://www.gnu.org/software/make/) (optional) 43 | 44 | Install all dependencies and development dependencies: 45 | 46 | ```sh 47 | eask install-deps --dev 48 | ``` 49 | 50 | To test the package's installation: 51 | 52 | ```sh 53 | eask package 54 | eask install 55 | ``` 56 | 57 | To test compilation: 58 | 59 | ```sh 60 | eask compile 61 | ``` 62 | 63 | **🪧 The following steps are optional, but we recommend you follow these lint results!** 64 | 65 | The built-in `checkdoc` linter: 66 | 67 | ```sh 68 | eask lint checkdoc 69 | ``` 70 | 71 | The standard `package` linter: 72 | 73 | ```sh 74 | eask lint package 75 | ``` 76 | 77 | *📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.* 78 | 79 | ## Optional Configuration 80 | 81 | `zig-mode` used to enable coloration of the compilation buffer using 82 | ANSI color codes, but this affected *all* compilation buffers, not just 83 | zig compilation output. 84 | If you want to restore this behavior, you can add the following snippet 85 | to your `init.el` or `.emacs` file: 86 | 87 | ```elisp 88 | (if (>= emacs-major-version 28) 89 | (add-hook 'compilation-filter-hook 'ansi-color-compilation-filter) 90 | (progn 91 | (defun colorize-compilation-buffer () 92 | (let ((inhibit-read-only t)) 93 | (ansi-color-apply-on-region compilation-filter-start (point)))) 94 | (add-hook 'compilation-filter-hook 'colorize-compilation-buffer))) 95 | ``` 96 | 97 | ## License 98 | 99 | `zig-mode` is distributed under the terms of the GNU General Public License as 100 | published by the Free Software Foundation; either version 3, or (at your 101 | option) any later version. 102 | 103 | See the [LICENSE](LICENSE) file for details. 104 | -------------------------------------------------------------------------------- /test/zig-tests.el: -------------------------------------------------------------------------------- 1 | ;; Tests for zig-mode. 2 | 3 | (require 'ert) 4 | (require 'zig-mode) 5 | (require 'imenu) 6 | 7 | ;;===========================================================================;; 8 | ;; Font lock tests 9 | 10 | (defun zig-test-font-lock (code expected) 11 | (let* ((fontified-code 12 | (with-temp-buffer 13 | (zig-mode) 14 | (insert code) 15 | (font-lock-fontify-buffer) 16 | (buffer-string))) 17 | (start 0) 18 | (actual '())) 19 | (while start 20 | (let* ((end (next-single-property-change start 'face fontified-code)) 21 | (substring (substring-no-properties fontified-code start end)) 22 | (face (get-text-property start 'face fontified-code))) 23 | (when face 24 | (setq actual (cons (list substring face) actual))) 25 | (setq start end))) 26 | (should (equal expected (reverse actual))))) 27 | 28 | (ert-deftest test-font-lock-backslash-in-char-literal () 29 | (zig-test-font-lock 30 | "const escaped = '\\'';" 31 | '(("const" font-lock-keyword-face) 32 | ("escaped" font-lock-variable-name-face) 33 | ("'\\''" font-lock-string-face)))) 34 | 35 | (ert-deftest test-font-lock-backslash-in-multiline-str-literal () 36 | (zig-test-font-lock 37 | " 38 | const string = 39 | \\\\ This newline is NOT escaped \\ 40 | ;" 41 | '(("const" font-lock-keyword-face) 42 | ("string" font-lock-variable-name-face) 43 | ("\\\\ This newline is NOT escaped \\" zig-multiline-string-face)))) 44 | 45 | (ert-deftest test-font-lock-backslash-in-str-literal () 46 | (zig-test-font-lock 47 | "\"This quote \\\" is escaped\"" 48 | '(("\"This quote \\\" is escaped\"" font-lock-string-face)))) 49 | 50 | (ert-deftest test-font-lock-builtins () 51 | (zig-test-font-lock 52 | "const std = @import(\"std\");" 53 | '(("const" font-lock-keyword-face) 54 | ("std" font-lock-variable-name-face) 55 | ("@import" font-lock-builtin-face) 56 | ("\"std\"" font-lock-string-face)))) 57 | 58 | (ert-deftest test-font-lock-comments () 59 | (zig-test-font-lock 60 | " 61 | // This is a normal comment\n 62 | /// This is a doc comment\n 63 | //// This is a normal comment again\n" 64 | '(("// " font-lock-comment-delimiter-face) 65 | ("This is a normal comment\n" font-lock-comment-face) 66 | ("/// This is a doc comment\n" font-lock-doc-face) 67 | ("//// " font-lock-comment-delimiter-face) 68 | ("This is a normal comment again\n" font-lock-comment-face)))) 69 | 70 | (ert-deftest test-font-lock-decl-const () 71 | (zig-test-font-lock 72 | "const greeting = \"Hello, world!\";" 73 | '(("const" font-lock-keyword-face) 74 | ("greeting" font-lock-variable-name-face) 75 | ("\"Hello, world!\"" font-lock-string-face)))) 76 | 77 | (ert-deftest test-font-lock-decl-fn () 78 | (zig-test-font-lock 79 | "fn plus1(value: u32) u32 { return value + 1; }" 80 | '(("fn" font-lock-keyword-face) 81 | ("plus1" font-lock-function-name-face) 82 | ("value" font-lock-variable-name-face) 83 | ("u32" font-lock-type-face) 84 | ("u32" font-lock-type-face) 85 | ("return" font-lock-keyword-face)))) 86 | 87 | (ert-deftest test-font-lock-decl-var () 88 | (zig-test-font-lock 89 | "var finished = false;" 90 | '(("var" font-lock-keyword-face) 91 | ("finished" font-lock-variable-name-face) 92 | ("false" font-lock-constant-face)))) 93 | 94 | (ert-deftest test-font-lock-multiline-str-literal () 95 | (zig-test-font-lock 96 | " 97 | const python = 98 | \\\\def main(): 99 | \\\\ print(\"Hello, world!\") 100 | ;" 101 | '(("const" font-lock-keyword-face) 102 | ("python" font-lock-variable-name-face) 103 | ("\\\\def main():" zig-multiline-string-face) 104 | ("\\\\ print(\"Hello, world!\")" zig-multiline-string-face)))) 105 | 106 | (ert-deftest test-font-lock-parameters-pointers-and-arrays () 107 | (zig-test-font-lock 108 | "fn doSomething(thingPtr: *Thing, string: []const u8, maybeFoo: ?Foo) void {}" 109 | '(("fn" font-lock-keyword-face) 110 | ("doSomething" font-lock-function-name-face) 111 | ("thingPtr" font-lock-variable-name-face) 112 | ("Thing" font-lock-type-face) 113 | ("string" font-lock-variable-name-face) 114 | ("const" font-lock-keyword-face) 115 | ("u8" font-lock-type-face) 116 | ("maybeFoo" font-lock-variable-name-face) 117 | ("Foo" font-lock-type-face) 118 | ("void" font-lock-type-face) 119 | ))) 120 | 121 | (ert-deftest test-font-lock-parameters-with-periods () 122 | (zig-test-font-lock 123 | "fn doSomething(arg: thing.with.periods) void {}" 124 | '(("fn" font-lock-keyword-face) 125 | ("doSomething" font-lock-function-name-face) 126 | ("arg" font-lock-variable-name-face) 127 | ("thing.with.periods" font-lock-type-face) 128 | ("void" font-lock-type-face) 129 | ))) 130 | 131 | (ert-deftest test-font-lock-struct-type-with-periods () 132 | (zig-test-font-lock 133 | "const S = struct { field: thing.with.periods }; " 134 | '(("const" font-lock-keyword-face) 135 | ("S" font-lock-variable-name-face) 136 | ("struct" font-lock-keyword-face) 137 | ("field" font-lock-variable-name-face) 138 | ("thing.with.periods" font-lock-type-face) 139 | ))) 140 | 141 | ;; Test all permutations of '?', '*', '[]', '* const', and '[] const' for 3 of those in a row 142 | ;; For example, ??[]Bar or [][]const *Bar 143 | (ert-deftest test-font-lock-parameters-optionals-pointers-and-arrays () 144 | (dotimes (i (* 5 5 5)) 145 | (let* ((int-to-opt-ptr-array (lambda (x) 146 | (pcase x (0 "?") (1 "*") (2 "[]") (3 "*const ") (4 "[]const ")))) 147 | (first-symbol-int (/ i (* 5 5))) 148 | (second-symbol-int (/ (% i (* 5 5)) 5)) 149 | (third-symbol-int (% i 5)) 150 | (first-symbol-const (>= first-symbol-int 3)) 151 | (second-symbol-const (>= second-symbol-int 3)) 152 | (third-symbol-const (>= third-symbol-int 3)) 153 | (first-symbol (funcall int-to-opt-ptr-array first-symbol-int)) 154 | (second-symbol (funcall int-to-opt-ptr-array second-symbol-int)) 155 | (third-symbol (funcall int-to-opt-ptr-array third-symbol-int)) 156 | (test-string (concat "fn foo(bar: " first-symbol second-symbol third-symbol "Bar) void {}")) 157 | (expected (append '(("fn" font-lock-keyword-face) 158 | ("foo" font-lock-function-name-face) 159 | ("bar" font-lock-variable-name-face)) 160 | (if first-symbol-const '(("const" font-lock-keyword-face)) nil) 161 | (if second-symbol-const '(("const" font-lock-keyword-face)) nil) 162 | (if third-symbol-const '(("const" font-lock-keyword-face)) nil) 163 | '(("Bar" font-lock-type-face) 164 | ("void" font-lock-type-face))))) 165 | (zig-test-font-lock test-string expected)))) 166 | 167 | (ert-deftest test-font-lock-int-types () 168 | (zig-test-font-lock 169 | "const Types = .{ u0, i7, u33, i123, u55555 };" 170 | '(("const" font-lock-keyword-face) 171 | ("Types" font-lock-variable-name-face) 172 | ("u0" font-lock-type-face) 173 | ("i7" font-lock-type-face) 174 | ("u33" font-lock-type-face) 175 | ("i123" font-lock-type-face) 176 | ("u55555" font-lock-type-face)))) 177 | 178 | (ert-deftest test-font-lock-escaped-backslash () 179 | (zig-test-font-lock 180 | "const a = foo('\\\\', \"C:\\\\\", \\\\ 181 | );" 182 | '(("const" font-lock-keyword-face) 183 | ("a" font-lock-variable-name-face) 184 | ("'\\\\'" font-lock-string-face) 185 | ("\"C:\\\\\"" font-lock-string-face) 186 | ("\\\\" zig-multiline-string-face)))) 187 | 188 | ;;===========================================================================;; 189 | ;; Indentation tests 190 | 191 | (defun zig-test-indent-line (line-number original expected-line) 192 | (with-temp-buffer 193 | (zig-mode) 194 | (insert original) 195 | (goto-line line-number) 196 | (indent-for-tab-command) 197 | (let* ((current-line (thing-at-point 'line t)) 198 | (stripped-line (replace-regexp-in-string "\n\\'" "" current-line))) 199 | (should (equal expected-line stripped-line))))) 200 | 201 | (ert-deftest test-indent-from-current-block () 202 | (zig-test-indent-line 203 | 6 204 | " 205 | { 206 | // Normally, zig-mode indents to 4, but suppose 207 | // someone indented this part to 2 for some reason. 208 | { 209 | // This line should get indented to 6, not 8. 210 | } 211 | }" 212 | " // This line should get indented to 6, not 8.")) 213 | 214 | (defun zig-test-indent-region (original expected) 215 | (with-temp-buffer 216 | (zig-mode) 217 | (insert original) 218 | (indent-region 1 (+ 1 (buffer-size))) 219 | (should (equal expected (buffer-string))))) 220 | 221 | (ert-deftest test-indent-top-level () 222 | (zig-test-indent-region 223 | " const four = 4;" 224 | "const four = 4;")) 225 | 226 | (ert-deftest test-indent-fn-def-body () 227 | (zig-test-indent-region 228 | " 229 | pub fn plus1(value: u32) u32 { 230 | return value + 1; 231 | }" 232 | " 233 | pub fn plus1(value: u32) u32 { 234 | return value + 1; 235 | }")) 236 | 237 | (ert-deftest test-indent-fn-def-args () 238 | (zig-test-indent-region 239 | " 240 | pub fn add(value1: u32, 241 | value2: u32) u32 { 242 | return value1 + value2; 243 | }" 244 | " 245 | pub fn add(value1: u32, 246 | value2: u32) u32 { 247 | return value1 + value2; 248 | }")) 249 | 250 | (ert-deftest test-indent-fn-call-args () 251 | (zig-test-indent-region 252 | " 253 | blarg(foo, 254 | foo + bar + baz + 255 | quux, 256 | quux);" 257 | " 258 | blarg(foo, 259 | foo + bar + baz + 260 | quux, 261 | quux);")) 262 | 263 | (ert-deftest test-indent-if-else-statement () 264 | (zig-test-indent-region 265 | " 266 | fn sign(value: i32) i32 { 267 | if (value > 0) return 1; 268 | else if (value < 0) { 269 | return -1; 270 | } else { 271 | return 0; 272 | } 273 | }" 274 | " 275 | fn sign(value: i32) i32 { 276 | if (value > 0) return 1; 277 | else if (value < 0) { 278 | return -1; 279 | } else { 280 | return 0; 281 | } 282 | }")) 283 | 284 | (ert-deftest test-indent-if-else-expression () 285 | (zig-test-indent-region 286 | " 287 | fn sign(i: i32) i32 { 288 | return if (i == 0) 289 | 0 290 | else if (i > 0) 291 | -1 292 | else 293 | -1; 294 | }" 295 | " 296 | fn sign(i: i32) i32 { 297 | return if (i == 0) 298 | 0 299 | else if (i > 0) 300 | -1 301 | else 302 | -1; 303 | }")) 304 | 305 | (ert-deftest test-indent-struct () 306 | (zig-test-indent-region 307 | " 308 | const Point = struct { 309 | x: f32, 310 | y: f32, 311 | }; 312 | const origin = Point { 313 | .x = 0.0, 314 | .y = 0.0, 315 | };" 316 | " 317 | const Point = struct { 318 | x: f32, 319 | y: f32, 320 | }; 321 | const origin = Point { 322 | .x = 0.0, 323 | .y = 0.0, 324 | };")) 325 | 326 | (ert-deftest test-indent-multiline-str-literal () 327 | (zig-test-indent-region 328 | " 329 | const code = 330 | \\\\const foo = []u32{ 331 | \\\\ 12345, 332 | \\\\}; 333 | ;" 334 | " 335 | const code = 336 | \\\\const foo = []u32{ 337 | \\\\ 12345, 338 | \\\\}; 339 | ;")) 340 | 341 | (ert-deftest test-indent-array-literal-1 () 342 | (zig-test-indent-region 343 | " 344 | const msgs = [][]u8{ 345 | \"hello\", 346 | \"goodbye\", 347 | };" 348 | " 349 | const msgs = [][]u8{ 350 | \"hello\", 351 | \"goodbye\", 352 | };")) 353 | 354 | (ert-deftest test-indent-array-literal-2 () 355 | (zig-test-indent-region 356 | " 357 | const msg = []u8{'h', 'e', 'l', 'l', 'o', 358 | 'w', 'o', 'r', 'l', 'd'};" 359 | " 360 | const msg = []u8{'h', 'e', 'l', 'l', 'o', 361 | 'w', 'o', 'r', 'l', 'd'};")) 362 | 363 | (ert-deftest test-indent-paren-block () 364 | (zig-test-indent-region 365 | " 366 | const foo = ( 367 | some_very_long + expression_that_is * set_off_in_parens 368 | );" 369 | " 370 | const foo = ( 371 | some_very_long + expression_that_is * set_off_in_parens 372 | );")) 373 | 374 | (ert-deftest test-indent-double-paren-block () 375 | (zig-test-indent-region 376 | " 377 | const foo = (( 378 | this_expression_is + set_off_in_double_parens * for_some_reason 379 | ));" 380 | " 381 | const foo = (( 382 | this_expression_is + set_off_in_double_parens * for_some_reason 383 | ));")) 384 | 385 | (ert-deftest test-indent-with-comment-after-open-brace () 386 | (zig-test-indent-region 387 | " 388 | if (false) { // This comment shouldn't mess anything up. 389 | launchTheMissiles(); 390 | }" 391 | " 392 | if (false) { // This comment shouldn't mess anything up. 393 | launchTheMissiles(); 394 | }")) 395 | 396 | ;;===========================================================================;; 397 | ;; Imenu tests 398 | 399 | ;; taken from rust-mode 400 | (defun test-imenu (code expected-items) 401 | (with-temp-buffer 402 | (zig-mode) 403 | (insert code) 404 | (let ((actual-items 405 | ;; Replace ("item" . # 4 | ;; Andrew Kelley 5 | ;; Maintainer: Shen, Jen-Chieh 6 | ;; URL: https://github.com/zig-lang/zig-mode 7 | ;; Version: 0.0.8 8 | ;; Package-Requires: ((emacs "26.1") (reformatter "0.6")) 9 | ;; Keywords: zig, languages 10 | 11 | ;; This file is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation; either version 3, or (at your option) 14 | ;; any later version. 15 | 16 | ;; This file is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; A major mode for the Zig programming languages. 27 | 28 | ;; See documentation on https://github.com/zig-lang/zig-mode 29 | 30 | ;;; Code: 31 | 32 | (require 'reformatter) 33 | 34 | (defgroup zig-mode nil 35 | "Support for Zig code." 36 | :link '(url-link "https://ziglang.org/") 37 | :group 'languages) 38 | 39 | (defcustom zig-indent-offset 4 40 | "Indent Zig code by this number of spaces." 41 | :type 'integer 42 | :safe #'integerp) 43 | 44 | (defcustom zig-format-on-save t 45 | "Format buffers before saving using zig fmt." 46 | :type 'boolean 47 | :safe #'booleanp) 48 | 49 | (defcustom zig-ast-check-on-format nil 50 | "Look for simple compile errors on format." 51 | :type 'boolean 52 | :safe #'booleanp) 53 | 54 | (defcustom zig-zig-bin "zig" 55 | "Path to zig executable." 56 | :type 'file 57 | :safe #'stringp) 58 | 59 | (defcustom zig-run-optimization-mode "Debug" 60 | "Optimization mode to run code with." 61 | :type 'string 62 | :safe #'stringp) 63 | 64 | (defcustom zig-test-optimization-mode "Debug" 65 | "Optimization mode to run tests with." 66 | :type 'string 67 | :safe #'stringp) 68 | 69 | ;; zig CLI commands 70 | 71 | (defun zig--run-cmd (cmd &optional source &rest args) 72 | "Use compile command to execute a zig CMD with ARGS if given. 73 | If given a SOURCE, execute the CMD on it." 74 | (let ((cmd-args (if source (cons source args) args))) 75 | (save-some-buffers) 76 | (compilation-start (mapconcat 'shell-quote-argument 77 | `(,zig-zig-bin ,cmd ,@cmd-args) " ")))) 78 | 79 | ;;;###autoload 80 | (defun zig-compile () 81 | "Compile using `zig build`." 82 | (interactive) 83 | (zig--run-cmd "build")) 84 | 85 | ;;;###autoload 86 | (defun zig-build-exe () 87 | "Create executable from source or object file." 88 | (interactive) 89 | (zig--run-cmd "build-exe" (file-local-name (buffer-file-name)))) 90 | 91 | ;;;###autoload 92 | (defun zig-build-lib () 93 | "Create library from source or assembly." 94 | (interactive) 95 | (zig--run-cmd "build-lib" (file-local-name (buffer-file-name)))) 96 | 97 | ;;;###autoload 98 | (defun zig-build-obj () 99 | "Create object from source or assembly." 100 | (interactive) 101 | (zig--run-cmd "build-obj" (file-local-name (buffer-file-name)))) 102 | 103 | ;;;###autoload 104 | (defun zig-test-buffer () 105 | "Test buffer using `zig test`." 106 | (interactive) 107 | (zig--run-cmd "test" (file-local-name (buffer-file-name)) "-O" zig-test-optimization-mode)) 108 | 109 | ;;;###autoload 110 | (defun zig-run () 111 | "Create an executable from the current buffer and run it immediately." 112 | (interactive) 113 | (zig--run-cmd "run" (file-local-name (buffer-file-name)) "-O" zig-run-optimization-mode)) 114 | 115 | ;; zig fmt 116 | (reformatter-define zig-format 117 | :program zig-zig-bin 118 | :args (append '("fmt" "--stdin") 119 | (when (string-match-p "\\.zon\\'" buffer-file-name) '("--zon")) 120 | (when zig-ast-check-on-format '("--ast-check"))) 121 | :group 'zig-mode 122 | :lighter " ZigFmt") 123 | 124 | ;;;###autoload (autoload 'zig-format-buffer "zig-mode" nil t) 125 | ;;;###autoload (autoload 'zig-format-region "zig-mode" nil t) 126 | ;;;###autoload (autoload 'zig-format-on-save-mode "zig-mode" nil t) 127 | 128 | (defun zig-re-word (inner) 129 | "Construct a regular expression for the word INNER." 130 | (concat "\\<" inner "\\>")) 131 | 132 | (defun zig-re-grab (inner) 133 | "Construct a group regular expression for INNER." 134 | (concat "\\(" inner "\\)")) 135 | 136 | (defconst zig-re-optional "\\(?:[[:space:]]*\\?[[:space:]]*\\)") 137 | (defconst zig-re-pointer "\\(?:[[:space:]]*\\*\\(?:const[[:space:]]*\\)?[[:space:]]*\\)") 138 | (defconst zig-re-array "\\(?:[[:space:]]*\\[[^]]*\\]\\(?:const[[:space:]]*\\)?[[:space:]]*\\)") 139 | 140 | (defconst zig-re-optionals-pointers-arrays 141 | (concat "\\(?:" zig-re-optional "\\|" zig-re-pointer "\\|" zig-re-array "\\)*")) 142 | 143 | (defconst zig-re-identifier "[[:word:]_][[:word:]_[:digit:]]*") 144 | (defconst zig-re-type "[[:word:]_.][[:word:]_.[:digit:]]*") 145 | (defconst zig-re-type-annotation 146 | (concat (zig-re-grab zig-re-identifier) 147 | "[[:space:]]*:[[:space:]]*" 148 | zig-re-optionals-pointers-arrays 149 | (zig-re-grab zig-re-type))) 150 | 151 | (defconst zig-re-block-label-open " \\([[:word:]_]+:\\)[[:space:]]*{") 152 | (defconst zig-re-block-label-break "break[[:space:]]*\\(:[[:word:]_]+\\)") 153 | 154 | (defun zig-re-definition (dtype) 155 | "Construct a regular expression for definitions of type DTYPE." 156 | (concat (zig-re-word dtype) "[[:space:]]+" (zig-re-grab zig-re-identifier))) 157 | 158 | (defconst zig-mode-syntax-table 159 | (let ((table (make-syntax-table))) 160 | 161 | ;; Operators 162 | (dolist (i '(?+ ?- ?* ?/ ?% ?& ?| ?= ?! ?< ?>)) 163 | (modify-syntax-entry i "." table)) 164 | 165 | ;; Strings 166 | (modify-syntax-entry ?\' "\"" table) 167 | (modify-syntax-entry ?\" "\"" table) 168 | (modify-syntax-entry ?\\ "\\" table) 169 | 170 | ;; Comments 171 | (modify-syntax-entry ?/ ". 12" table) 172 | (modify-syntax-entry ?\n ">" table) 173 | 174 | table)) 175 | 176 | (defconst zig-electric-indent-chars 177 | '(?\; ?\, ?\) ?\] ?\})) 178 | 179 | (defface zig-multiline-string-face 180 | '((t :inherit font-lock-string-face)) 181 | "Face for multiline string literals.") 182 | 183 | (defvar zig-font-lock-keywords 184 | (append 185 | `(;; Builtins (prefixed with @) 186 | (,(concat "@" zig-re-identifier) . font-lock-builtin-face) 187 | 188 | ;; Keywords, constants and types 189 | (,(rx symbol-start 190 | (| 191 | ;; Storage 192 | "const" "var" "extern" "packed" "export" "pub" "noalias" "inline" 193 | "noinline" "comptime" "callconv" "volatile" "allowzero" 194 | "align" "linksection" "threadlocal" "addrspace" 195 | 196 | ;; Structure 197 | "struct" "enum" "union" "error" "opaque" 198 | 199 | ;; Statement 200 | "break" "return" "continue" "asm" "defer" "errdefer" "unreachable" 201 | "try" "catch" "async" "nosuspend" "await" "suspend" "resume" 202 | 203 | ;; Conditional 204 | "if" "else" "switch" "and" "or" "orelse" 205 | 206 | ;; Repeat 207 | "while" "for" 208 | 209 | ;; Other keywords 210 | "fn" "usingnamespace" "test") 211 | symbol-end) 212 | . font-lock-keyword-face) 213 | 214 | (,(rx symbol-start 215 | (| 216 | ;; Boolean 217 | "true" "false" 218 | 219 | ;; Other constants 220 | "null" "undefined") 221 | symbol-end) 222 | . font-lock-constant-face) 223 | 224 | (,(rx symbol-start 225 | (| 226 | ;; Integer types 227 | (: (any ?i ?u) (| ?0 (: (any (?1 . ?9)) (* digit)))) 228 | "isize" "usize" 229 | 230 | ;; Floating types 231 | "f16" "f32" "f64" "f80" "f128" 232 | 233 | ;; C types 234 | "c_char" "c_short" "c_ushort" "c_int" "c_uint" "c_long" "c_ulong" 235 | "c_longlong" "c_ulonglong" "c_longdouble" 236 | 237 | ;; Comptime types 238 | "comptime_int" "comptime_float" 239 | 240 | ;; Other types 241 | "bool" "void" "noreturn" "type" "anyerror" "anyframe" "anytype" 242 | "anyopaque") 243 | symbol-end) 244 | . font-lock-type-face) 245 | 246 | ;; Block labels 247 | (,zig-re-block-label-open 1 font-lock-constant-face) 248 | (,zig-re-block-label-break 1 font-lock-constant-face) 249 | 250 | ;; Type annotations (both variable and type) 251 | (,zig-re-type-annotation 1 font-lock-variable-name-face) 252 | (,zig-re-type-annotation 2 font-lock-type-face)) 253 | 254 | ;; Definitions 255 | (mapcar (lambda (x) 256 | (list (zig-re-definition (car x)) 257 | 1 (cdr x))) 258 | '(("const" . font-lock-variable-name-face) 259 | ("var" . font-lock-variable-name-face) 260 | ("fn" . font-lock-function-name-face))))) 261 | 262 | (defun zig-paren-nesting-level () (nth 0 (syntax-ppss))) 263 | (defun zig-currently-in-str () (nth 3 (syntax-ppss))) 264 | (defun zig-start-of-current-str-or-comment () (nth 8 (syntax-ppss))) 265 | 266 | (defun zig-skip-backwards-past-whitespace-and-comments () 267 | (while (or 268 | ;; If inside a comment, jump to start of comment. 269 | (let ((start (zig-start-of-current-str-or-comment))) 270 | (and start 271 | (not (zig-currently-in-str)) 272 | (goto-char start))) 273 | ;; Skip backwards past whitespace and comment end delimiters. 274 | (/= 0 (skip-syntax-backward " >"))))) 275 | 276 | (defun zig-in-str-or-cmnt () (nth 8 (syntax-ppss))) 277 | (defconst zig-top-item-beg-re 278 | (concat "^ *" 279 | (regexp-opt 280 | '("pub" "extern" "export" "")) 281 | "[[:space:]]*" 282 | (regexp-opt 283 | '("fn" "test")) 284 | "[[:space:]]+") 285 | "Start of a Zig item.") 286 | 287 | (defun zig-beginning-of-defun (&optional arg) 288 | "Move backward to the beginning of the current defun. 289 | 290 | With ARG, move backward multiple defuns. Negative ARG means 291 | move forward. 292 | 293 | This is written mainly to be used as `beginning-of-defun-function' for Zig." 294 | (interactive "p") 295 | (let* ((arg (or arg 1)) 296 | (magnitude (abs arg)) 297 | (sign (if (< arg 0) -1 1))) 298 | ;; If moving forward, don't find the defun we might currently be 299 | ;; on. 300 | (when (< sign 0) 301 | (end-of-line)) 302 | (catch 'done 303 | (dotimes (_ magnitude) 304 | ;; Search until we find a match that is not in a string or comment. 305 | (while (if (re-search-backward (concat "^[[:space:]]*\\(" zig-top-item-beg-re "\\)") 306 | nil 'move sign) 307 | (zig-in-str-or-cmnt) 308 | ;; Did not find it. 309 | (throw 'done nil))))) 310 | t)) 311 | 312 | (defun zig-end-of-defun () 313 | "Move forward to the next end of defun. 314 | 315 | With argument, do it that many times. 316 | Negative argument -N means move back to Nth preceding end of defun. 317 | 318 | Assume that this is called after `beginning-of-defun'. So point is 319 | at the beginning of the defun body. 320 | 321 | This is written mainly to be used as `end-of-defun-function' for Zig." 322 | (interactive) 323 | 324 | ;; Jump over the function parameters and paren-wrapped return, if they exist. 325 | (while (re-search-forward "(" (line-end-position) t) 326 | (progn 327 | (backward-char) 328 | (forward-sexp))) 329 | 330 | ;; Find the opening brace 331 | (if (re-search-forward "[{]" nil t) 332 | (progn 333 | (goto-char (match-beginning 0)) 334 | ;; Go to the closing brace 335 | (condition-case nil 336 | (forward-sexp) 337 | (scan-error 338 | (goto-char (point-max)))) 339 | (end-of-line)) 340 | ;; There is no opening brace, so consider the whole buffer to be one "defun" 341 | (goto-char (point-max)))) 342 | 343 | (defun zig-mode-indent-line () 344 | (interactive) 345 | ;; First, calculate the column that this line should be indented to. 346 | (let ((indent-col 347 | (save-excursion 348 | (back-to-indentation) 349 | (let* (;; paren-level: How many sets of parens (or other delimiters) 350 | ;; we're within, except that if this line closes the 351 | ;; innermost set(s) (e.g. the line is just "}"), then we 352 | ;; don't count those set(s). 353 | (paren-level 354 | (save-excursion 355 | (while (looking-at "[]})]") (forward-char)) 356 | (zig-paren-nesting-level))) 357 | ;; prev-block-indent-col: If we're within delimiters, this is 358 | ;; the column to which the start of that block is indented 359 | ;; (if we're not, this is just zero). 360 | (prev-block-indent-col 361 | (if (<= paren-level 0) 0 362 | (save-excursion 363 | (while (>= (zig-paren-nesting-level) paren-level) 364 | (backward-up-list) 365 | (back-to-indentation)) 366 | (current-column)))) 367 | ;; base-indent-col: The column to which a complete expression 368 | ;; on this line should be indented. 369 | (base-indent-col 370 | (if (<= paren-level 0) 371 | prev-block-indent-col 372 | (or (save-excursion 373 | (backward-up-list) 374 | (forward-char) 375 | (and (not (looking-at " *\\(//[^\n]*\\)?\n")) 376 | (current-column))) 377 | (+ prev-block-indent-col zig-indent-offset)))) 378 | ;; is-expr-continuation: True if this line continues an 379 | ;; expression from the previous line, false otherwise. 380 | (is-expr-continuation 381 | (and 382 | (not (looking-at "[]});]\\|else")) 383 | (save-excursion 384 | (zig-skip-backwards-past-whitespace-and-comments) 385 | (when (> (point) 1) 386 | (backward-char) 387 | (or (zig-currently-in-str) 388 | (not (looking-at "[,;([{}]")))))))) 389 | ;; Now we can calculate indent-col: 390 | (if is-expr-continuation 391 | (+ base-indent-col zig-indent-offset) 392 | base-indent-col))))) 393 | ;; If point is within the indentation whitespace, move it to the end of the 394 | ;; new indentation whitespace (which is what the indent-line-to function 395 | ;; always does). Otherwise, we don't want point to move, so we use a 396 | ;; save-excursion. 397 | (if (<= (current-column) (current-indentation)) 398 | (indent-line-to indent-col) 399 | (save-excursion (indent-line-to indent-col))))) 400 | 401 | (defun zig-syntax-propertize-multiline-string (end) 402 | (let* ((eol (save-excursion (search-forward "\n" end t))) 403 | (stop (or eol end))) 404 | (while (search-forward "\\" stop t) 405 | (put-text-property (match-beginning 0) (match-end 0) 'syntax-table (string-to-syntax "."))) 406 | (when eol (put-text-property (- eol 2) (1- eol) 'syntax-table (string-to-syntax "|"))) 407 | (goto-char stop))) 408 | 409 | (defun zig-syntax-propertize (start end) 410 | (goto-char start) 411 | (when (eq t (zig-currently-in-str)) 412 | (zig-syntax-propertize-multiline-string end)) 413 | (while (search-forward "\\\\" end t) 414 | (when (null (save-excursion (backward-char 2) (zig-currently-in-str))) 415 | (backward-char) 416 | (put-text-property (match-beginning 0) (point) 'syntax-table (string-to-syntax "|")) 417 | (zig-syntax-propertize-multiline-string end)))) 418 | 419 | (defun zig-mode-syntactic-face-function (state) 420 | (save-excursion 421 | (goto-char (nth 8 state)) 422 | (if (nth 3 state) 423 | (if (looking-at "\\\\\\\\") 424 | 'zig-multiline-string-face 425 | 'font-lock-string-face) 426 | (if (looking-at "//[/!][^/]") 427 | 'font-lock-doc-face 428 | 'font-lock-comment-face)))) 429 | 430 | ;;; Imenu support 431 | (defun zig-re-structure-def-imenu (stype) 432 | "Construct a regular expression for strucutres definitions of type STYPE." 433 | (concat (zig-re-word "const") "[[:space:]]+" 434 | (zig-re-grab zig-re-identifier) 435 | ".*" 436 | (zig-re-word stype))) 437 | 438 | (defvar zig-imenu-generic-expression 439 | (append (mapcar (lambda (x) 440 | (list (capitalize x) (zig-re-structure-def-imenu x) 1)) 441 | '("enum" "struct" "union")) 442 | `(("Fn" ,(zig-re-definition "fn") 1)))) 443 | 444 | (defvar zig-mode-map 445 | (let ((map (make-sparse-keymap))) 446 | (define-key map (kbd "C-c C-b") #'zig-compile) 447 | (define-key map (kbd "C-c C-f") #'zig-format-buffer) 448 | (define-key map (kbd "C-c C-r") #'zig-run) 449 | (define-key map (kbd "C-c C-t") #'zig-test-buffer) 450 | map) 451 | "Keymap for Zig major mode.") 452 | 453 | ;;;###autoload 454 | (define-derived-mode zig-mode prog-mode "Zig" 455 | "A major mode for the Zig programming language." 456 | (setq-local comment-start "// ") 457 | (setq-local comment-start-skip "//+ *") 458 | (setq-local comment-end "") 459 | (setq-local electric-indent-chars 460 | (append zig-electric-indent-chars 461 | (and (boundp 'electric-indent-chars) 462 | electric-indent-chars))) 463 | (setq-local beginning-of-defun-function 'zig-beginning-of-defun) 464 | (setq-local end-of-defun-function 'zig-end-of-defun) 465 | (setq-local indent-line-function 'zig-mode-indent-line) 466 | (setq-local indent-tabs-mode nil) ; Zig forbids tab characters. 467 | (setq-local syntax-propertize-function 'zig-syntax-propertize) 468 | (setq-local imenu-generic-expression zig-imenu-generic-expression) 469 | (setq-local compile-command "zig build") 470 | (setq buffer-file-coding-system 'utf-8-unix) ; zig source is always utf-8 471 | (setq font-lock-defaults '(zig-font-lock-keywords 472 | nil nil nil nil 473 | (font-lock-syntactic-face-function . zig-mode-syntactic-face-function))) 474 | 475 | (when zig-format-on-save 476 | (zig-format-on-save-mode 1))) 477 | 478 | ;;;###autoload 479 | (add-to-list 'auto-mode-alist '("\\.\\(zig\\|zon\\)\\'" . zig-mode)) 480 | 481 | (provide 'zig-mode) 482 | ;;; zig-mode.el ends here 483 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------