├── .gitignore
├── .github
    ├── dependabot.yml
    └── workflows
    │   └── test.yml
├── Makefile
├── Eask
├── tests
    ├── php-ts-mode-tests.el
    └── php-ts-mode-resources
    │   ├── movement.erts
    │   ├── indent.erts
    │   └── face.erts
├── README.md
├── php-face.el
├── php-ts-mode.el
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | *.elc
2 | php-ts-mode-autoloads.el
3 | php-ts-mode-pkg.el
4 | /.eask
5 | /dist
6 | # emacs tmp files
7 | *~
8 | *#
9 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | updates:
3 |   - package-ecosystem: github-actions
4 |     directory: /
5 |     schedule:
6 |       interval: daily
7 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | EMACS ?= emacs
 2 | EASK ?= eask
 3 | 
 4 | all: autoloads compile install
 5 | 
 6 | compile:
 7 | 	$(EASK) compile
 8 | 
 9 | install:
10 | 	$(EASK) package
11 | 	$(EASK) install
12 | 
13 | autoloads:
14 | 	$(EASK) generate autoloads
15 | 
16 | clean:
17 | 	$(EASK) clean all
18 | 
19 | test: clean all install
20 | 	$(EASK) test ert ./tests/php-ts-mode-tests.el
21 | 
22 | .PHONY: all autoloads clean test
23 | 


--------------------------------------------------------------------------------
/Eask:
--------------------------------------------------------------------------------
 1 | ;; -*- mode: eask; lexical-binding: t -*-
 2 | 
 3 | (package "php-ts-mode"
 4 |          "0.0.1"
 5 |          "Tree-sitter support for PHP")
 6 | 
 7 | (website-url "https://github.com/emacs-php/php-ts-mode")
 8 | (keywords "languages" "php" "tree-sitter")
 9 | 
10 | (package-file "php-ts-mode.el")
11 | 
12 | (script "test" "echo \"Error: no test specified\" && exit 1")
13 | 
14 | (source 'gnu)
15 | 
16 | (depends-on "emacs" "29.1")
17 | 


--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | 
 3 | on:
 4 |   push:
 5 |     paths-ignore:
 6 |     - '**/*.md'
 7 |     - 'etc/*'
 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 |           - "29.4"
24 |           - "30.1"
25 |         experimental: [false]
26 |         include:
27 |           - os: ubuntu-latest
28 |             emacs-version: snapshot
29 |             experimental: true
30 |           - os: macos-latest
31 |             emacs-version: snapshot
32 |             experimental: true
33 |           - os: windows-latest
34 |             emacs-version: snapshot
35 |             experimental: true
36 |     steps:
37 |     - name: Checkout repo
38 |       uses: actions/checkout@v4
39 |     - uses: jcs090218/setup-emacs@master
40 |       with:
41 |         version: ${{ matrix.emacs-version }}
42 |     - uses: emacs-eask/setup-eask@master
43 |       with:
44 |         version: 'snapshot'
45 |     - name: Run tests
46 |       run: make test
47 | 


--------------------------------------------------------------------------------
/tests/php-ts-mode-tests.el:
--------------------------------------------------------------------------------
 1 | ;;; php-ts-mode-tests.el --- Tests for Tree-sitter-based PHP mode  -*- lexical-binding: t; -*-
 2 | 
 3 | ;; Copyright (C) 2022-2023 Free Software Foundation, Inc.
 4 | ;; Copyright (C) 2023  Friends of Emacs-PHP development
 5 | 
 6 | ;; This program is free software; you can redistribute it and/or modify
 7 | ;; it under the terms of the GNU General Public License as published by
 8 | ;; the Free Software Foundation, either version 3 of the License, or
 9 | ;; (at your option) any later version.
10 | 
11 | ;; This program is distributed in the hope that it will be useful,
12 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 | ;; GNU General Public License for more details.
15 | 
16 | ;; You should have received a copy of the GNU General Public License
17 | ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
18 | 
19 | ;;; Code:
20 | 
21 | (require 'ert)
22 | (require 'ert-x)
23 | (require 'treesit)
24 | 
25 | (declare-function treesit-install-language-grammar "treesit.c")
26 | 
27 | (if (and (treesit-available-p) (boundp 'treesit-language-source-alist))
28 |     (unless (treesit-language-available-p 'php)
29 |       (treesit-install-language-grammar 'php)))
30 | 
31 | (ert-deftest php-ts-mode-test-indentation ()
32 |   (skip-unless (treesit-ready-p 'php))
33 |   (ert-test-erts-file (ert-resource-file "indent.erts")))
34 | 
35 | ; FIXME: implement basic movements
36 | (ert-deftest php-ts-mode-test-movement ()
37 |  (skip-unless (treesit-ready-p 'php))
38 |  (ert-test-erts-file (ert-resource-file "movement.erts")))
39 | 
40 | (ert-deftest php-ts-mode-test-face ()
41 |  (skip-unless (treesit-ready-p 'php))
42 |  (ert-test-erts-file (ert-resource-file "face.erts")))
43 | 
44 | (provide 'php-ts-mode-tests)
45 | ;;; php-ts-mode-tests.el ends here
46 | 


--------------------------------------------------------------------------------
/tests/php-ts-mode-resources/movement.erts:
--------------------------------------------------------------------------------
  1 | Code:
  2 |   (lambda ()
  3 |     (php-ts-mode)
  4 |     (beginning-of-defun))
  5 | 
  6 | Name: beginning-of-defun moves to method start
  7 | 
  8 | Point-Char: |
  9 | 
 10 | =-=
 11 | <?php
 12 | 
 13 | class Basic
 14 | {
 15 |     public function basic(): void
 16 |     {
 17 |         return;|
 18 |     }
 19 | }
 20 | =-=
 21 | <?php
 22 | 
 23 | class Basic
 24 | {
 25 | |    public function basic(): void
 26 |     {
 27 |         return;
 28 |     }
 29 | }
 30 | =-=-=
 31 | 
 32 | Code:
 33 |   (lambda ()
 34 |     (php-ts-mode)
 35 |     (end-of-defun))
 36 | 
 37 | Name: end-of-defun moves to method end
 38 | 
 39 | Point-Char: |
 40 | 
 41 | =-=
 42 | <?php
 43 | 
 44 | class Basic
 45 | {
 46 |     public function basic(): void
 47 |     {
 48 |         return;|
 49 |     }
 50 | }
 51 | =-=
 52 | <?php
 53 | 
 54 | class Basic
 55 | {
 56 |     public function basic(): void
 57 |     {
 58 |         return;
 59 |     }
 60 | |}
 61 | =-=-=
 62 | 
 63 | Code:
 64 |   (lambda ()
 65 |     (php-ts-mode)
 66 |     (beginning-of-defun)
 67 |     (beginning-of-defun))
 68 | 
 69 | Name: beginning-of-defun twice moves to class start
 70 | 
 71 | Point-Char: |
 72 | 
 73 | =-=
 74 | <?php
 75 | 
 76 | class Basic
 77 | {
 78 |     public function basic(): void
 79 |     {
 80 |         return;|
 81 |     }
 82 | }
 83 | =-=
 84 | <?php
 85 | 
 86 | |class Basic
 87 | {
 88 |     public function basic(): void
 89 |     {
 90 |         return;
 91 |     }
 92 | }
 93 | =-=-=
 94 | 
 95 | Code:
 96 |   (lambda ()
 97 |     (php-ts-mode)
 98 |     (end-of-defun)
 99 |     (end-of-defun))
100 | 
101 | Name: end-of-defun twice moves to class block end
102 | 
103 | Point-Char: |
104 | 
105 | =-=
106 | <?php
107 | 
108 | class Basic
109 | {
110 |     public function basic(): void
111 |     {
112 |         return;|
113 |     }
114 | }
115 | 
116 | =-=
117 | <?php
118 | 
119 | class Basic
120 | {
121 |     public function basic(): void
122 |     {
123 |         return;
124 |     }
125 | }
126 | |
127 | =-=-=
128 | 


--------------------------------------------------------------------------------
/tests/php-ts-mode-resources/indent.erts:
--------------------------------------------------------------------------------
  1 | Code:
  2 |   (lambda ()
  3 |     (setq indent-tabs-mode nil)
  4 |     (setq php-ts-mode-indent-offset 4)
  5 |     (setq tab-width 4)
  6 |     (php-ts-mode)
  7 |     (indent-region (point-min) (point-max)))
  8 | 
  9 | Point-Char: |
 10 | 
 11 | Name: Basic
 12 | 
 13 | =-=
 14 | <?php
 15 | 
 16 | class Basic {
 17 |     public function basic(): void {
 18 |         return;
 19 |     }
 20 | }
 21 | =-=-=
 22 | 
 23 | Name: Empty Line
 24 | 
 25 | =-=
 26 | <?php
 27 | 
 28 | class EmptyLine {
 29 |     public function emptyLine(): void {
 30 |         |
 31 |     }
 32 | }
 33 | =-=-=
 34 | Name: Function
 35 | 
 36 | =-=
 37 | <?php
 38 | 
 39 | function basic(): void {
 40 |     return;
 41 | }
 42 | =-=-=
 43 | 
 44 | Name: Function with a PHPDoc
 45 | 
 46 | =-=
 47 | <?php
 48 | 
 49 | /**
 50 |  * Summary
 51 |  */
 52 | function with_phpdoc(): void {
 53 |     return;
 54 | }
 55 | =-=-=
 56 | 
 57 | Name: Namespace function
 58 | 
 59 | =-=
 60 | <?php
 61 | 
 62 | namespace Ns;
 63 | 
 64 | function ns_func(): void {
 65 |     return;
 66 | }
 67 | =-=-=
 68 | 
 69 | Name: Function with an attribute
 70 | 
 71 | =-=
 72 | <?php
 73 | 
 74 | namespace Ns;
 75 | 
 76 | #[Attribute]
 77 | function with_an_attr(): void {
 78 |     return;
 79 | }
 80 | =-=-=
 81 | 
 82 | Name: Function with two attributes
 83 | 
 84 | =-=
 85 | <?php
 86 | 
 87 | namespace Ns;
 88 | 
 89 | #[Attribute]
 90 | #[Attribute]
 91 | function with_two_attrs(): void {
 92 |     return;
 93 | }
 94 | =-=-=
 95 | 
 96 | Name: Opening bracket on new line
 97 | 
 98 | =-=
 99 | <?php
100 | 
101 | class Test
102 | {
103 |     public function test(): void
104 | {
105 |         return;
106 |     }
107 | }
108 | =-=
109 | <?php
110 | 
111 | class Test
112 | {
113 |     public function test(): void
114 |     {
115 |         return;
116 |     }
117 | }
118 | =-=-=
119 | 
120 | Name: Switch default statement
121 | 
122 | =-=
123 | <?php
124 | 
125 | function test()
126 | {
127 |     switch ($cond) {
128 |         case 1:
129 |             return 1;
130 |         default:
131 |         return 2;
132 |     }
133 | }
134 | =-=
135 | <?php
136 | 
137 | function test()
138 | {
139 |     switch ($cond) {
140 |         case 1:
141 |             return 1;
142 |         default:
143 |             return 2;
144 |     }
145 | }
146 | =-=-=
147 | 
148 | Name: Match statement
149 | 
150 | =-=
151 | <?php
152 | match ($t) {
153 | 1 => 1
154 | };
155 | =-=
156 | <?php
157 | match ($t) {
158 |     1 => 1
159 | };
160 | =-=-=
161 | 


--------------------------------------------------------------------------------
/tests/php-ts-mode-resources/face.erts:
--------------------------------------------------------------------------------
  1 | Code:
  2 |   (lambda ()
  3 |     (php-ts-mode)
  4 |     (customize-set-variable 'treesit-font-lock-level 4)
  5 |     (let ((face (symbol-name (face-at-point))))
  6 |         (erase-buffer)
  7 |         (insert face)))
  8 | 
  9 | Name: Open php tag
 10 | Point-Char: |
 11 | No-After-Newline: t
 12 | 
 13 | =-=
 14 | <?p|hp
 15 | =-=
 16 | php-php-tag
 17 | =-=-=
 18 | 
 19 | Name: Keyword `class`
 20 | No-After-Newline: t
 21 | 
 22 | =-=
 23 | <?php
 24 | cla|ss Basic {}
 25 | =-=
 26 | php-keyword
 27 | =-=-=
 28 | 
 29 | Name: Keyword `public`
 30 | No-After-Newline: t
 31 | 
 32 | =-=
 33 | <?php
 34 | 
 35 | class Basic {
 36 |     pub|lic function basic() {}
 37 | }
 38 | =-=
 39 | php-keyword
 40 | =-=-=
 41 | 
 42 | Name: Keyword `match`
 43 | No-After-Newline: t
 44 | 
 45 | =-=
 46 | <?php
 47 | |match ($t){}
 48 | =-=
 49 | php-keyword
 50 | =-=-=
 51 | 
 52 | Name: Class name
 53 | No-After-Newline: t
 54 | 
 55 | =-=
 56 | <?php
 57 | class Ba|sic {}
 58 | =-=
 59 | php-class
 60 | =-=-=
 61 | 
 62 | Name: Base clause
 63 | No-After-Newline: t
 64 | 
 65 | =-=
 66 | <?php
 67 | class Basic extends Par|ent{}
 68 | =-=
 69 | php-class
 70 | =-=-=
 71 | 
 72 | Name: Base clause with qualified name
 73 | No-After-Newline: t
 74 | 
 75 | =-=
 76 | <?php
 77 | class Test extends \test\T|est {}
 78 | =-=
 79 | php-class
 80 | =-=-=
 81 | 
 82 | Name: This sigil
 83 | No-After-Newline: t
 84 | 
 85 | =-=
 86 | <?php
 87 | |$this
 88 | =-=
 89 | php-this-sigil
 90 | =-=-=
 91 | 
 92 | Name: This
 93 | No-After-Newline: t
 94 | 
 95 | =-=
 96 | <?php
 97 | $t|his
 98 | =-=
 99 | php-this
100 | =-=-=
101 | 
102 | Name: Optional type
103 | No-After-Newline: t
104 | 
105 | =-=
106 | <?php
107 | function test(|?int $arg) {}
108 | =-=
109 | php-type
110 | =-=-=
111 | 
112 | Name: Scoped propery access
113 | No-After-Newline: t
114 | 
115 | =-=
116 | <?php
117 | |Test::$test;
118 | =-=
119 | php-class
120 | =-=-=
121 | 
122 | Name: Scoped propery access with qualified name
123 | No-After-Newline: t
124 | 
125 | =-=
126 | <?php
127 | \Te|st::$test;
128 | =-=
129 | php-class
130 | =-=-=
131 | 
132 | Name: Class constant access with qualified name
133 | No-After-Newline: t
134 | 
135 | =-=
136 | <?php
137 | |\Test::TEST;
138 | =-=
139 | php-class
140 | =-=-=
141 | 
142 | Name: Trait use declation
143 | No-After-Newline: t
144 | 
145 | =-=
146 | <?php
147 | class Test {
148 |     use Te|st;
149 | }
150 | =-=
151 | php-class
152 | =-=-=
153 | 
154 | Name: Built-in function
155 | No-After-Newline: t
156 | 
157 | =-=
158 | <?php
159 | iss|et($t)
160 | =-=
161 | php-keyword
162 | =-=-=
163 | 
164 | Name: Unset statement
165 | No-After-Newline: t
166 | 
167 | =-=
168 | <?php
169 | uns|et($t)
170 | =-=
171 | php-keyword
172 | =-=-=
173 | 
174 | Name: Object create expression with qualified name
175 | No-After-Newline: t
176 | 
177 | =-=
178 | <?php
179 | $t = new |\Test();
180 | =-=
181 | php-class
182 | =-=-=
183 | 
184 | Name: Scoped call expression with qualified name
185 | No-After-Newline: t
186 | 
187 | =-=
188 | <?php
189 | \Te|st::test();
190 | =-=
191 | php-class
192 | =-=-=
193 | 
194 | Name: Attribute name
195 | No-After-Newline: t
196 | 
197 | =-=
198 | <?php
199 | #[At|tr]
200 | class Test {}
201 | =-=
202 | php-class
203 | =-=-=
204 | 
205 | Name: Attribute qualified name
206 | No-After-Newline: t
207 | 
208 | =-=
209 | <?php
210 | #[\At|tr]
211 | class Test {}
212 | =-=
213 | php-class
214 | =-=-=
215 | 
216 | Name: Instanceof class
217 | No-After-Newline: t
218 | 
219 | =-=
220 | <?php
221 | $a instanceof |B;
222 | =-=
223 | php-class
224 | =-=-=
225 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # php-ts-mode
 2 | 
 3 | A Tree-sitter based major mode for editing PHP codes.
 4 | 
 5 | > [!NOTE]
 6 | > This package is based on Emacs 29's built-in [`treesit`][treesit] and `c-ts-common` features.  
 7 | > `php-ts-mode` has been tested with [v0.21.1][] of [tree-sitter-php][].
 8 | 
 9 | [treesit]: https://www.gnu.org/software/emacs/manual/html_node/elisp/Language-Grammar.html
10 | [tree-sitter-php]: https://github.com/tree-sitter/tree-sitter-php
11 | [v0.21.1]: https://github.com/tree-sitter/tree-sitter-php/releases/tag/v0.21.1
12 | 
13 | ## How to install
14 | 
15 | If you haven't installed Tree-sitter yet, please read [How to Get Started with Tree-Sitter - Mastering Emacs][].  At this point, Tree-sitter may be too early for those who cannot compile and install it themselves. You will end up recompiling it with every future update of [tree-sitter-php][].
16 | 
17 | [How to Get Started with Tree-Sitter - Mastering Emacs]: https://www.masteringemacs.org/article/how-to-get-started-tree-sitter
18 | 
19 | Package can be installed by running the following command.
20 | 
21 | ```
22 | M-x package-vc-install [RET] https://github.com/emacs-php/php-ts-mode
23 | ```
24 | 
25 | ### Configuration
26 | 
27 | Example configuration that you can put in your `.emacs` file
28 | 
29 | ```
30 | ;; Enable variables highlighting
31 | (customize-set-variable 'treesit-font-lock-level 4)
32 | 
33 | (add-hook 'php-ts-mode-hook (lambda ()
34 | 			      ;; Use spaces for indent
35 | 			      (setq-local indent-tabs-mode nil)))
36 | ```
37 | 
38 | ### Grammer installation
39 | 
40 | If you don't already have `php-ts-mode` installed, please evaluate the Lisp code below.
41 | 
42 | ```elisp
43 | (add-to-list 'treesit-language-source-alist
44 |              '(php "https://github.com/tree-sitter/tree-sitter-php" "master" "php/src"))
45 | ```
46 | 
47 | Running `M-x treesit-install-language-grammar [RET] php` will compile and install the latest [tree-sitter-php][].
48 | 
49 | ## Settings
50 | 
51 | ### Syntax highlighting
52 | 
53 | In `php-ts-mode`, syntax elements are classified as follows.
54 | 
55 |  * **Level 1**: `comment` `definition` `preprocessor`
56 |  * **Level 2**: `keyword` `string` `type`
57 |  * **Level 3**: `function` `constant` `label`
58 |  * **Level 4**: `bracket` `delimiter` `operator` `variables` `this`
59 | 
60 | By default, up to **Level 3** will be highlighted.
61 | 
62 | ## How to develop
63 | 
64 |  1. Chekout [tree-sitter-php][] to your computer.
65 |  2. Do `make install`
66 | 
67 | ## Copyright
68 | 
69 | This code is currently based on [java-ts-mode](https://emba.gnu.org/emacs/emacs/-/blob/master/lisp/progmodes/java-ts-mode.el).
70 | 
71 | > Copyright (C) 2022-2023 Free Software Foundation, Inc.
72 | > Copyright (C) 2023  Friends of Emacs-PHP development
73 | >
74 | > This program is free software; you can redistribute it and/or modify
75 | > it under the terms of the GNU General Public License as published by
76 | > the Free Software Foundation, either version 3 of the License, or
77 | > (at your option) any later version.
78 | >
79 | > This program is distributed in the hope that it will be useful,
80 | > but WITHOUT ANY WARRANTY; without even the implied warranty of
81 | > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
82 | > GNU General Public License for more details.
83 | >
84 | > You should have received a copy of the GNU General Public License
85 | > along with this program.  If not, see <https://www.gnu.org/licenses/>.
86 | 
87 | There are plans to transfer this project to GNU Emacs, so if you haven't assigned a copyright to the FSF yet, please refer to the [Org-mode contribute guide](https://orgmode.org/worg/org-contribute.html#copyright) and send me an email!
88 | 


--------------------------------------------------------------------------------
/php-face.el:
--------------------------------------------------------------------------------
  1 | ;;; php-face.el --- Face definitions for PHP script  -*- lexical-binding: t; -*-
  2 | 
  3 | ;; Copyright (C) 2023  Friends of Emacs-PHP development
  4 | 
  5 | ;; Author: USAMI Kenta <tadsan@zonu.me>
  6 | ;; Created: 5 May 2019
  7 | ;; Version: 1.25.0
  8 | ;; Keywords: faces, php
  9 | ;; Homepage: https://github.com/emacs-php/php-mode
 10 | ;; License: GPL-3.0-or-later
 11 | 
 12 | ;; This program is free software; you can redistribute it and/or modify
 13 | ;; it under the terms of the GNU General Public License as published by
 14 | ;; the Free Software Foundation, either version 3 of the License, or
 15 | ;; (at your option) any later version.
 16 | 
 17 | ;; This program is distributed in the hope that it will be useful,
 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 20 | ;; GNU General Public License for more details.
 21 | 
 22 | ;; You should have received a copy of the GNU General Public License
 23 | ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
 24 | 
 25 | ;;; Commentary:
 26 | 
 27 | ;; Face definitions for PHP script.
 28 | 
 29 | ;;; Code:
 30 | 
 31 | ;;;###autoload
 32 | (defgroup php-faces nil
 33 |   "Faces used in PHP Mode."
 34 |   :tag "PHP Faces"
 35 |   :group 'php-mode
 36 |   :group 'faces)
 37 | 
 38 | (defface php-string '((t (:inherit font-lock-string-face)))
 39 |   "PHP Mode face used to highlight string literals."
 40 |   :group 'php-faces
 41 |   :tag "PHP String")
 42 | 
 43 | (defface php-keyword '((t (:inherit font-lock-keyword-face)))
 44 |   "PHP Mode face used to highlight keywords."
 45 |   :group 'php-faces
 46 |   :tag "PHP Keyword")
 47 | 
 48 | (defface php-builtin '((t (:inherit font-lock-builtin-face)))
 49 |   "PHP Mode face used to highlight builtins."
 50 |   :group 'php-faces
 51 |   :tag "PHP Built-in")
 52 | 
 53 | (defface php-function-name '((t (:inherit font-lock-function-name-face)))
 54 |   "PHP Mode face used to highlight function names."
 55 |   :group 'php-faces
 56 |   :tag "PHP Function Name")
 57 | 
 58 | (defface php-function-call '((t ()))
 59 |   "PHP Mode face used to highlight function names in calles."
 60 |   :group 'php-faces
 61 |   :tag "PHP Function Call")
 62 | 
 63 | (defface php-method-call '((t (:inherit php-function-call)))
 64 |   "PHP Mode face used to highlight method names in calles."
 65 |   :group 'php-faces
 66 |   :tag "PHP Method Call")
 67 | 
 68 | (defface php-static-method-call '((t (:inherit php-method-call)))
 69 |   "PHP Mode face used to highlight static method names in calles."
 70 |   :group 'php-faces
 71 |   :tag "PHP Static Method Call")
 72 | 
 73 | (defface php-variable-name '((t (:inherit font-lock-variable-name-face)))
 74 |   "PHP Mode face used to highlight variable names."
 75 |   :group 'php-faces
 76 |   :tag "PHP Variable Name")
 77 | 
 78 | (defface php-property-name '((t (:inherit php-variable-name)))
 79 |   "PHP Mode face used to highlight property names."
 80 |   :group 'php-faces
 81 |   :tag "PHP Property Name")
 82 | 
 83 | (defface php-variable-sigil '((t ()))
 84 |   "PHP Mode face used to highlight variable sigils ($)."
 85 |   :group 'php-faces
 86 |   :tag "PHP Variable Sigil")
 87 | 
 88 | (defface php-operator '((t ()))
 89 |   "PHP Mode face used to operators."
 90 |   :group 'php-faces
 91 |   :tag "PHP Operator")
 92 | 
 93 | (defface php-assignment-op '((t (:inherit php-operator)))
 94 |   "PHP Mode face used to assignment operators (=, +=, ...)."
 95 |   :group 'php-faces
 96 |   :tag "PHP Object Op")
 97 | 
 98 | (defface php-comparison-op '((t (:inherit php-operator)))
 99 |   "PHP Mode face used to comparison operators (==, !=, ===, ...)."
100 |   :group 'php-faces
101 |   :tag "PHP Comparison Op")
102 | 
103 | (defface php-logical-op '((t (:inherit php-operator)))
104 |   "PHP Mode face used to logical operators (&&, ||, ?:)."
105 |   :group 'php-faces
106 |   :tag "PHP Logical Op")
107 | 
108 | (defface php-arithmetic-op '((t (:inherit php-operator)))
109 |   "PHP Mode face used to arithmetic operators (+, -, %, ...)."
110 |   :group 'php-faces
111 |   :tag "PHP Arithmetic Op")
112 | 
113 | (defface php-inc-dec-op '((t (:inherit php-operator)))
114 |   "PHP Mode face used to increment and decremt operators (--, ++)."
115 |   :group 'php-faces
116 |   :tag "PHP Increment/Decrement Op")
117 | 
118 | (defface php-string-op '((t (:inherit php-operator)))
119 |   "PHP Mode face used to logical operators (.)."
120 |   :group 'php-faces
121 |   :tag "PHP String Op")
122 | 
123 | (defface php-object-op '((t (:inherit php-operator)))
124 |   "PHP Mode face used to object operators (->)."
125 |   :group 'php-faces
126 |   :tag "PHP Object Op")
127 | 
128 | (defface php-paamayim-nekudotayim '((t ()))
129 |   "PHP Mode face used to highlight scope resolution operators (::).
130 | The operator is also knows as \"Paamayim Nekudotayim\"."
131 |   :group 'php-faces
132 |   :tag "PHP Paamayim Nekudotayim")
133 | 
134 | (defface php-type '((t (:inherit font-lock-type-face)))
135 |   "PHP Mode face used to highlight types."
136 |   :group 'php-faces
137 |   :tag "PHP Type")
138 | 
139 | (defface php-class '((t (:inherit font-lock-type-face)))
140 |   "PHP Mode face used to highlight class."
141 |   :group 'php-faces
142 |   :tag "PHP Class")
143 | 
144 | (defface php-constant '((t (:inherit font-lock-constant-face)))
145 |   "PHP Mode face used to highlight constants."
146 |   :group 'php-faces
147 |   :tag "PHP Constant")
148 | 
149 | (defface php-constant-assign '((t (:inherit php-constant)))
150 |   "PHP Mode face used to highlight constant assigning (\"const\" statement)."
151 |   :group 'php-faces
152 |   :tag "PHP Constant Assign")
153 | 
154 | (defface php-magical-constant '((t (:inherit font-lock-builtin-face)))
155 |   "PHP Mode face used to highlight magical constants."
156 |   :group 'php-faces
157 |   :tag "PHP Magical Constant")
158 | 
159 | (defface php-this '((t (:inherit php-constant)))
160 |   "PHP Mode face used to highlight $this variables."
161 |   :group 'php-faces
162 |   :tag "PHP $this")
163 | 
164 | (defface php-this-sigil '((t (:inherit php-constant)))
165 |   "PHP Mode face used to highlight sigils($) of $this variable."
166 |   :group 'php-faces
167 |   :tag "PHP $this Sigil")
168 | 
169 | (define-obsolete-face-alias 'php-$this 'php-this "1.26.0")
170 | (define-obsolete-face-alias 'php-$this-sigil 'php-this-sigil "1.26.0")
171 | 
172 | (defface php-errorcontrol-op '((t (:inherit font-lock-type-face)))
173 |   "PHP Mode face used to highlight errorcontrol operators (@).."
174 |   :group 'php-faces
175 |   :tag "PHP ErrorControl Op")
176 | 
177 | (defface php-php-tag '((t (:inherit font-lock-preprocessor-face)))
178 |   "PHP Mode face used to highlight PHP tags."
179 |   :group 'php-faces
180 |   :tag "PHP php Tag")
181 | 
182 | (defface php-doc-annotation-tag (eval-when-compile
183 |                                   (if (eval-when-compile (boundp 'font-lock-doc-markup-face))
184 |                                       '((t . (:inherit font-lock-doc-markup-face)))
185 |                                     '((t . (:inherit font-lock-constant-face)))))
186 |   "Face used to highlight annotation tags in doc-comment."
187 |   :group 'php-faces
188 |   :tag "PHPDoc Annotation Tag")
189 | 
190 | (defface php-doc-variable-sigil '((t (:inherit font-lock-variable-name-face)))
191 |   "PHP Mode face used to highlight variable sigils($)."
192 |   :group 'php-faces
193 |   :tag "PHPDoc Variable Sigil")
194 | 
195 | (defface php-doc-$this '((t (:inherit php-type)))
196 |   "PHP Mode face used to highlight $this variable in doc-comment."
197 |   :group 'php-faces
198 |   :tag "PHPDoc $this")
199 | 
200 | (defface php-doc-$this-sigil '((t (:inherit php-type)))
201 |   "PHP Mode face used to highlight sigil of $this variable in doc-comment."
202 |   :group 'php-faces
203 |   :tag "PHPDoc $this Sigil")
204 | 
205 | (defface php-doc-class-name '((t (:inherit php-string)))
206 |   "PHP Mode Face used to class names in doc-comment."
207 |   :group 'php-faces
208 |   :tag "PHPDoc Class Name")
209 | 
210 | (defface php-class-declaration '((t (:inherit php-keyword)))
211 |   "PHP Mode Face used to class declarations."
212 |   :group 'php-faces
213 |   :tag "PHP Class Declaration")
214 | 
215 | (defface php-class-declaration-spec '((t (:inherit php-keyword)))
216 |   "PHP Mode Face used to highlight class declaration specification keywords.
217 | The keywords include: implements, extends."
218 |   :group 'php-faces
219 |   :tag "PHP Class Declaration Specification")
220 | 
221 | (defface php-namespace-declaration '((t (:inherit php-keyword)))
222 |   "PHP Mode Face used to highlight namespace declaration keyword."
223 |   :group 'php-faces
224 |   :tag "PHP Namespace Declaration")
225 | 
226 | (defface php-import-declaration '((t (:inherit php-keyword)))
227 |   "PHP Mode Face used to highlight import statements (use ... as ...)."
228 |   :group 'php-faces
229 |   :tag "PHP Import Statement")
230 | 
231 | (defface php-class-modifier '((t (:inherit php-keyword)))
232 |   "PHP Mode Face used to highlight class modifiers (final, abstract)."
233 |   :group 'php-faces
234 |   :tag "PHP Class Modifier")
235 | 
236 | (defface php-method-modifier '((t (:inherit php-keyword)))
237 |   "PHP Mode Face used to highlight method modifiers (final, abstract)."
238 |   :group 'php-faces
239 |   :tag "PHP Method Modifier")
240 | 
241 | (defface php-visibility-modifier '((t (:inherit php-keyword)))
242 |   "PHP Mode Face used to highlight access keywords (public, protected, private)."
243 |   :group 'php-faces
244 |   :tag "PHP Visibility Modifier")
245 | 
246 | (defface php-control-structure '((t (:inherit php-keyword)))
247 |   "PHP Mode Face used to highlight control structures.
248 | The control structures include: if, foreach, while, switch, catch."
249 |   :group 'php-faces
250 |   :tag "PHP Control Structure")
251 | 
252 | (define-obsolete-face-alias 'php-annotations-annotation-face 'php-doc-annotation-tag "1.19.0")
253 | 
254 | (provide 'php-face)
255 | ;;; php-face.el ends here
256 | 


--------------------------------------------------------------------------------
/php-ts-mode.el:
--------------------------------------------------------------------------------
  1 | ;;; php-ts-mode.el --- Tree-sitter support for PHP   -*- lexical-binding: t; -*-
  2 | 
  3 | ;; Copyright (C) 2022-2023 Free Software Foundation, Inc.
  4 | ;; Copyright (C) 2023  Friends of Emacs-PHP development
  5 | 
  6 | ;; Author: USAMI Kenta <tadsan@zonu.me>
  7 | ;; Created: 01 Apr 2023
  8 | ;; URL: https://github.com/emacs-php/php-ts-mode
  9 | ;; Version: 0.0.1
 10 | ;; Package-Requires: ((emacs "29.1"))
 11 | ;; License: GPL-3.0-or-later
 12 | ;; Keywords: languages, php, tree-sitter
 13 | 
 14 | ;; This program is free software; you can redistribute it and/or modify
 15 | ;; it under the terms of the GNU General Public License as published by
 16 | ;; the Free Software Foundation, either version 3 of the License, or
 17 | ;; (at your option) any later version.
 18 | 
 19 | ;; This program is distributed in the hope that it will be useful,
 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 22 | ;; GNU General Public License for more details.
 23 | 
 24 | ;; You should have received a copy of the GNU General Public License
 25 | ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
 26 | 
 27 | ;;; Commentary:
 28 | 
 29 | ;; A Tree-sitter based major mode for editing PHP codes.
 30 | 
 31 | ;;; Code:
 32 | (eval-when-compile
 33 |   (require 'cc-mode)
 34 |   (require 'cl-lib))
 35 | (require 'treesit)
 36 | (require 'c-ts-common)
 37 | (require 'php nil t)
 38 | (require 'php-face nil t)
 39 | 
 40 | (declare-function php-base-mode "ext:php")
 41 | (declare-function treesit-parser-create "treesit.c")
 42 | (declare-function treesit-induce-sparse-tree "treesit.c")
 43 | (declare-function treesit-node-child "treesit.c")
 44 | (declare-function treesit-node-child-by-field-name "treesit.c")
 45 | (declare-function treesit-node-start "treesit.c")
 46 | (declare-function treesit-node-type "treesit.c")
 47 | (declare-function treesit-search-subtree "treesit.c")
 48 | 
 49 | (defcustom php-ts-mode-indent-offset 4
 50 |   "Number of spaces for each indentation step in `php-ts-mode'."
 51 |   :version "29.1"
 52 |   :type 'integer
 53 |   :safe 'integerp
 54 |   :group 'php)
 55 | 
 56 | (defvar php-ts-mode--syntax-table
 57 |   (eval-when-compile
 58 |     (let ((table (make-syntax-table)))
 59 |       (c-populate-syntax-table table)
 60 |       (modify-syntax-entry ?_ "w" table)
 61 |       (modify-syntax-entry ?`  "\"" table)
 62 |       (modify-syntax-entry ?\" "\"" table)
 63 |       (modify-syntax-entry ?#  "< b" table)
 64 |       (modify-syntax-entry ?\n "> b" table)
 65 |       table)))
 66 | 
 67 | (defvar php-ts-mode--indent-rules
 68 |   (let ((offset php-ts-mode-indent-offset))
 69 |     `((php
 70 |        ((node-is "}") parent-bol 0)
 71 |        ((node-is ")") parent-bol 0)
 72 |        ((node-is "]") parent-bol 0)
 73 |        ((node-is "->") parent-bol ,offset)
 74 |        ((parent-is "program") column-0 0)
 75 |        ((parent-is "comment") parent-bol 1)
 76 |        ((parent-is "declaration_list") parent-bol ,offset)
 77 |        ;; "compound_statement" contains the body of many statements.
 78 |        ;; For example function_definition, foreach_statement, etc.
 79 |        ((parent-is "compound_statement") parent-bol ,offset)
 80 |        ((parent-is "method_declaration") parent-bol 0)
 81 |        ((parent-is "array_creation_expression") parent-bol ,offset)
 82 |        ((parent-is "base_clause") parent-bol ,offset)
 83 |        ((parent-is "class_interface_clause") parent-bol ,offset)
 84 |        ((parent-is "formal_parameters") parent-bol ,offset)
 85 |        ((parent-is "arguments") parent-bol ,offset)
 86 |        ((parent-is "parenthesized_expression") parent-bol ,offset)
 87 |        ((parent-is "binary_expression") parent-bol, 0)
 88 |        ((parent-is "switch_block") parent-bol ,offset)
 89 |        ((parent-is "case_statement") parent-bol ,offset)
 90 |        ((parent-is "default_statement") parent-bol ,offset)
 91 |        ((parent-is "match_block") parent-bol ,offset)
 92 |        ((parent-is "assignment_expression") parent-bol ,offset)
 93 |        ((parent-is "return_statement") parent-bol ,offset))))
 94 |   "Tree-sitter indent rules.")
 95 | 
 96 | (defvar php-ts-mode--keywords
 97 |   '("abstract" "as" "break" "case" "catch" "class" "const"
 98 |     "continue" "declare" "default" "do" "echo" "else"
 99 |     "elseif" "enddeclare" "endforeach" "endif" "endswitch"
100 |     "endwhile" "enum" "extends" "final" "finally" "for" "foreach"
101 |     "fn" "function" "global" "if" "implements" "include_once"
102 |     "include" "instanceof" "insteadof" "interface" "match" "namespace" "new"
103 |     "private" "protected" "public" "readonly" "require_once" "require"
104 |     "return" "static" "switch" "throw" "trait" "try" "use"
105 |     "while" "yield")
106 |   "PHP keywords for tree-sitter font-locking.")
107 | 
108 | (defvar php-ts-mode--built-in-functions
109 |   '("die" "empty" "isset")
110 |   "PHP built-in functions for tree-sitter font-locking.")
111 | 
112 | (defvar php-ts-mode--operators
113 |   '("!=" "!==" "%" "%=" "&" "&&" "&=" "*" "**" "*="
114 |      "+" "++" "+=" "," "-" "-" "--" "-=" "->" "."
115 |      ".=" "/" "/=" ":" "::" "<" "<<" "<<=" "<=" "<=>"
116 |      "<>" "=" "==" "===" "=>" ">" ">=" ">>" ">>=" "?"
117 |      "??" "??=" "?->" "@" "\\" "^" "^=" "|" "|=" "||")
118 |   "PHP operators for tree-sitter font-locking.")
119 | 
120 | (defconst php-ts-mode--magical-constants
121 |   '("__CLASS__" "__DIR__" "__FILE__" "__FUNCTION__" "__LINE__"
122 |     "__METHOD__" "__NAMESPACE__" "__TRAIT__")
123 |   "Magical keyword that is expanded at compile time.
124 | 
125 | These are different from \"constants\" in strict terms.
126 | see https://www.php.net/manual/language.constants.predefined.php")
127 | 
128 | (defvar php-ts-mode--font-lock-settings
129 |   (treesit-font-lock-rules
130 | 
131 |    :language 'php
132 |    :feature 'preprocessor
133 |    `([(php_tag)
134 |       ("?>")]
135 |      @php-php-tag)
136 | 
137 |    :language 'php
138 |    :feature 'constant
139 |    `((const_declaration (const_element (name) @font-lock-type-face))
140 |      ((name) @php-magical-constant
141 |       (:match ,(rx-to-string `(: bos (or ,@php-ts-mode--magical-constants) eos))
142 |               @php-magical-constant))
143 |      ((name) @php-constant
144 |       (:match ,(rx bos (? "_") (in "A-Z") (+ (in "0-9A-Z_")) eos)
145 |               @php-constant)))
146 | 
147 |    :language 'php
148 |    :feature 'type
149 |    `([(primitive_type)
150 |       (cast_type)
151 |       (bottom_type)
152 |       (named_type (name) @php-type)
153 |       (named_type (qualified_name) @php-type)
154 |       (namespace_use_clause)
155 |       (namespace_name (name))
156 |       (optional_type "?" @php-type)]
157 |      @php-type
158 |      (class_interface_clause [(name) (qualified_name)] @php-class)
159 |      (class_constant_access_expression
160 |       (name) @php-keyword
161 |       (:match ,(rx bos "class" eos)
162 |               @php-keyword))
163 |      (class_constant_access_expression
164 |       (name) @php-constant
165 |       (:match ,(rx bos (? "_") (in "A-Z") (+ (in "0-9A-Z_")) eos)
166 |               @php-constant))
167 |      (class_constant_access_expression
168 |       [(name) (qualified_name)] @php-class)
169 |      [(boolean)
170 |       (null)]
171 |      @php-constant
172 |      [(integer)
173 |       (float)]
174 |      @font-lock-number-face
175 |      (binary_expression
176 |       operator: "instanceof"
177 |       right: [(name) (qualified_name)] @php-class))
178 | 
179 |    :language 'php
180 |    :feature 'definition
181 |    :override t
182 |    `((class_declaration
183 |       name: (name) @php-class)
184 |      (interface_declaration
185 |       name: (name) @php-class)
186 |      (enum_declaration
187 |       name: (name) @php-class)
188 |      (trait_declaration
189 |       name: (name) @php-class)
190 |      (enum_case
191 |       name: (name) @php-class)
192 |      (base_clause [(name) (qualified_name)] @php-class)
193 |      (use_declaration [(name) (qualified_name)] @php-class))
194 | 
195 |    :language 'php
196 |    :feature 'function
197 |    :override t
198 |    `((array_creation_expression "array" @php-builtin)
199 |      (list_literal "list" @php-builtin)
200 |      (method_declaration
201 |       name: (name) @php-function-name)
202 |      (function_call_expression
203 |       function: [(qualified_name (name)) (name)] @php-function-call)
204 |      (scoped_call_expression
205 |       scope: [(name) (qualified_name)] @php-class
206 |       name: (name) @php-static-method-call)
207 |      (scoped_property_access_expression
208 |       scope: [(name) (qualified_name)] @php-class)
209 |      (member_call_expression
210 |       name: (name) @php-method-call)
211 |      (object_creation_expression [(name) (qualified_name)] @php-class)
212 |      (attribute [(name) (qualified_name)] @php-class)
213 |      (function_definition
214 |       name: (name) @php-function-name))
215 | 
216 |    :language 'php
217 |    :feature 'variables
218 |    `((relative_scope) @font-lock-builtin-face
219 |      (property_element
220 |       (variable_name) @php-property-name)
221 | 
222 |      ;; ((name) @constructor
223 |      ;;  (:match ,(rx-to-string '(: bos (in "A-Z")))))
224 |      (member_access_expression name: (name) @php-property-name)
225 |      ;;(variable_name (name) @font-lock-variable-name-face)
226 |      (variable_name (name) @php-variable-name)
227 |      (variable_name "$" @php-variable-sigil))
228 | 
229 |    :language 'php
230 |    :feature 'this
231 |    :override t
232 |    `((variable_name "$" @php-this-sigil (name) @php-this
233 | 		    (:match ,(rx bos "this" eos) @php-this)))
234 | 
235 |    :language 'php
236 |    :feature 'comment
237 |    `(((comment) @font-lock-doc-face
238 |       (:match ,(rx bos "/**")
239 |               @font-lock-doc-face))
240 |      (comment) @font-lock-comment-face)
241 | 
242 |    :language 'php
243 |    :feature 'string
244 |    `([(string)
245 |       (string_content)
246 |       (encapsed_string)
247 |       (heredoc)
248 |       (heredoc_body)
249 |       (nowdoc_body)]
250 |      @php-string)
251 | 
252 |    :language 'php
253 |    :feature 'operator
254 |    `([,@php-ts-mode--operators] @php-operator
255 |      (binary_expression operator: ["and" "or" "xor"] @php-operator))
256 | 
257 |    :language 'php
258 |    :feature 'keyword
259 |    :override t
260 |    `([,@php-ts-mode--keywords] @php-keyword
261 |      (print_intrinsic "print" @php-keyword)
262 |      (goto_statement "goto" @php-keyword)
263 |      (yield_expression "from" @php-keyword)
264 |      (function_call_expression
265 |       function: (name) @php-keyword
266 |       (:match ,(rx-to-string
267 |                 `(seq bol
268 |                       (or ,@php-ts-mode--built-in-functions)
269 |                       eol)) @php-keyword))
270 |      (unset_statement "unset" @php-keyword))
271 | 
272 |    :language 'php
273 |    :feature 'label
274 |    `((goto_statement (name) @php-keyword)
275 |      (named_label_statement (name) @php-keyword))
276 | 
277 |    :language 'php
278 |    :feature 'delimiter
279 |    '((["," ":" ";" "\\"]) @font-lock-delimiter-face
280 |      (class_constant_access_expression "::" @font-lock-preprocessor-face)
281 |      (attribute_group ["#[" "]"] @font-lock-preprocessor-face))
282 | 
283 |    :language 'php
284 |    :feature 'bracket
285 |    `((["(" ")" "[" "]" "{" "}"]) @font-lock-bracket-face))
286 |   "Tree-sitter font-lock settings for `php-ts-mode'.")
287 | 
288 | (defun php-ts-mode--defun-name (node)
289 |   "Return the defun name of NODE.
290 | Return nil if there is no name or if NODE is not a defun node."
291 |   (pcase (treesit-node-type node)
292 |     ((or "class_declaration"
293 |          "enum_declaration"
294 |          "function_definition"
295 |          "interface_declaration"
296 |          "method_declaration"
297 |          "namespace_definition"
298 |          "trait_declaration")
299 |      (treesit-node-text
300 |       (treesit-node-child-by-field-name node "name")
301 |       t))))
302 | 
303 | (unless (eval-when-compile (fboundp 'php-base-mode))
304 |   (define-derived-mode php-base-mode prog-mode "PHP base"
305 |     "Generic major mode for editing PHP script.
306 | 
307 | This mode is intended to be inherited by concrete major modes.
308 | Currently there are `php-mode' and `php-ts-mode'."
309 |     :group 'php
310 |     nil))
311 | 
312 | ;;;###autoload
313 | (define-derived-mode php-ts-mode php-base-mode "PHP"
314 |   "Major mode for editing PHP files, powered by tree-sitter."
315 |   :group 'php
316 |   :syntax-table php-ts-mode--syntax-table
317 | 
318 |   (unless (treesit-ready-p 'php)
319 |     (error "Tree-sitter for PHP isn't available"))
320 | 
321 |   (treesit-parser-create 'php)
322 | 
323 |   ;; Comments.
324 |   (c-ts-common-comment-setup)
325 |   (setq-local comment-start-skip
326 |               (eval-when-compile
327 |                 (rx (group (or (: "#" (not (any "[")))
328 |                                (: "/" (+ "/"))
329 |                                (: "/*")))
330 |                     (* (syntax whitespace)))))
331 | 
332 |   ;; Indent.
333 |   (setq-local c-ts-common-indent-type-regexp-alist
334 |               (eval-when-compile
335 |                 `((block . ,(rx (or "class_body"
336 |                                     "array_creation_expression"
337 |                                     "constructor_body"
338 |                                     "annotation_type_body"
339 |                                     "interface_body"
340 |                                     "lambda_expression"
341 |                                     "enum_body"
342 |                                     "switch_block"
343 |                                     "record_declaration_body"
344 |                                     "block")))
345 |                   (close-bracket . "}")
346 |                   (if . "if_statement")
347 |                   (else . ("if_statement" . "alternative"))
348 |                   (for . "for_statement")
349 |                   (while . "while_statement")
350 |                   (do . "do_statement"))))
351 |   (setq-local c-ts-common-indent-offset 'php-ts-mode-indent-offset)
352 |   (setq-local treesit-simple-indent-rules php-ts-mode--indent-rules)
353 |   (setq-local electric-indent-chars
354 |               (append "{}():;," electric-indent-chars))
355 | 
356 |   (setq-local treesit-defun-name-function #'php-ts-mode--defun-name)
357 | 
358 |   ;; Navigation
359 |   (setq-local treesit-defun-type-regexp
360 |               (regexp-opt '("class_declaration"
361 |                             "enum_declaration"
362 |                             "function_definition"
363 |                             "interface_declaration"
364 |                             "method_declaration"
365 |                             "namespace_definition"
366 |                             "trait_declaration")))
367 | 
368 |   ;; Font-lock.
369 |   (setq-local treesit-font-lock-settings php-ts-mode--font-lock-settings)
370 |   (setq-local treesit-font-lock-feature-list
371 |               '((comment definition preprocessor)
372 |                 (keyword string type)
373 |                 (function constant label)
374 |                 (bracket delimiter operator variables this)))
375 | 
376 |   ;; Imenu.
377 |   (setq-local treesit-simple-imenu-settings
378 |               '(("Namespace" "\\`namespace_definition\\'" nil nil)
379 |                 ("Enum" "\\`enum_declaration\\'" nil nil)
380 |                 ("Class" "\\`class_declaration\\'" nil nil)
381 |                 ("Interface" "\\`interface_declaration\\'" nil nil)
382 |                 ("Trait" "\\`trait_declaration\\'" nil nil)
383 |                 ("Method" "\\`method_declaration\\'" nil nil)))
384 | 
385 |   (treesit-major-mode-setup))
386 | 
387 | (when (treesit-ready-p 'php)
388 |   (add-to-list 'auto-mode-alist '("\\.php[s345]?\\'" . php-ts-mode)))
389 | 
390 | ;;;###autoload
391 | (with-eval-after-load 'treesit
392 |   (add-to-list 'treesit-language-source-alist
393 |                '(php "https://github.com/tree-sitter/tree-sitter-php" "master" "php/src")))
394 | 
395 | (provide 'php-ts-mode)
396 | ;;; php-ts-mode.el ends here
397 | 


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


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