tree-sitter-matlab 1.0.0__tar.gz

tree_sitter_matlab-1.0.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Álan Crístoffer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tree_sitter_matlab-1.0.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: tree-sitter-matlab
+Version: 1.0.0
+Summary: Matlab grammar for tree-sitter
+License: MIT
+Project-URL: Homepage, https://github.com/tree-sitter/tree-sitter-matlab
+Keywords: incremental,parsing,tree-sitter,matlab
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: core
+Requires-Dist: tree-sitter~=0.21; extra == "core"
+
+# MATLAB grammar for tree-sitter.
+
+There are screenshots at the end of this README :)
+
+This parser has the objective of generating a tree that is as correct as
+possible (but sometimes just convenient) with what MATLAB itself executes. It
+is not intended only for syntax highlight, but also to be used by scripts to
+whatever it may be needed. In fact, I wrote it because I'm a Neovim/Doom Emacs
+user and love having text-objects, and was really missing a text object for
+matrices rows/cells.
+
+Being as correct as possible means that some things are done correctly, for
+example:
+
+- Commands are parsed the same way MATLAB does it, by treating arguments as
+literals, grouping them correctly and only starting comments when allowed. It
+should perfectly match what MATLAB does.
+
+- Assignment has its own token, and multiple-variable assignment is NOT an
+assignment to a matrix (and returning an error is the correct thing to do, as
+it allows the user to see that something is off with the highlight, meaning
+something is probably off with the code):
+
+```matlab
+% (assignment (multioutput_variable (identifier) (identifier)) (identifier)) 
+[a,b] = d
+
+% this is WRONG:
+[a;b] = d
+```
+
+- Inside a matrix, `1 + 1` and `1 +1` are different things:
+
+```matlab
+a = 1 + 1 % 2
+a = 1 +1 %2
+[1 + 1] == [2]
+[1 +1]  == [1 1]
+```
+
+Being convenient means that sometimes the difference between what is acceptable
+and what is not acceptable lives in the semantics, so we can't know. In such
+cases I just accept semantically wrong but syntax correct things and group them
+in the same token (first example). I do the same when the overhead of
+generating a specific token would not really pay off (second example).
+
+- Function calls and Matrix Indexing are the same in MATLAB: `A(1)` can be any
+of them and you cannot tell them apart unless you know for sure what `A` is
+referring to. So for convenience I just generate a `function_call` for them and
+also for cell indexing `A{1}`. The "problem" with that is that this is a valid
+indexing but an invalid function call: `A(:)`. However I don't distinguish at
+all and say that all of them are `function_call`.
+
+- Function definitions, when inside a class, accepts a special syntax for the
+name of the function, allowing it to be preceded by either `get.` or `set.`,
+like `function get.name()`. I could have a `method_definition` that would allow
+that to only be valid in the class context, but I doubt that would be worth it.
+So any function anywhere can have those and be recognize as correct still.
+Given the existence of external method definition, maybe that is even the
+correct thing to do, since we don't know if the current file is inside a
+special class folder.
+
+# Installation
+
+This parser is now the default for the following editors:
+
+- Emacs: Through the `tree-sitter-langs` package.
+- Helix: Builtin, now in master and will be available in the next release (whatever comes after 23.05).
+- Neovim: Through the `nvim-treesitter` plugin.
+
+# Screenshots
+
+![First Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s1.png)
+![Second Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s2.png)
+![Third Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s3.png)

tree_sitter_matlab-1.0.0/README.md

@@ -0,0 +1,75 @@
+# MATLAB grammar for tree-sitter.
+
+There are screenshots at the end of this README :)
+
+This parser has the objective of generating a tree that is as correct as
+possible (but sometimes just convenient) with what MATLAB itself executes. It
+is not intended only for syntax highlight, but also to be used by scripts to
+whatever it may be needed. In fact, I wrote it because I'm a Neovim/Doom Emacs
+user and love having text-objects, and was really missing a text object for
+matrices rows/cells.
+
+Being as correct as possible means that some things are done correctly, for
+example:
+
+- Commands are parsed the same way MATLAB does it, by treating arguments as
+literals, grouping them correctly and only starting comments when allowed. It
+should perfectly match what MATLAB does.
+
+- Assignment has its own token, and multiple-variable assignment is NOT an
+assignment to a matrix (and returning an error is the correct thing to do, as
+it allows the user to see that something is off with the highlight, meaning
+something is probably off with the code):
+
+```matlab
+% (assignment (multioutput_variable (identifier) (identifier)) (identifier)) 
+[a,b] = d
+
+% this is WRONG:
+[a;b] = d
+```
+
+- Inside a matrix, `1 + 1` and `1 +1` are different things:
+
+```matlab
+a = 1 + 1 % 2
+a = 1 +1 %2
+[1 + 1] == [2]
+[1 +1]  == [1 1]
+```
+
+Being convenient means that sometimes the difference between what is acceptable
+and what is not acceptable lives in the semantics, so we can't know. In such
+cases I just accept semantically wrong but syntax correct things and group them
+in the same token (first example). I do the same when the overhead of
+generating a specific token would not really pay off (second example).
+
+- Function calls and Matrix Indexing are the same in MATLAB: `A(1)` can be any
+of them and you cannot tell them apart unless you know for sure what `A` is
+referring to. So for convenience I just generate a `function_call` for them and
+also for cell indexing `A{1}`. The "problem" with that is that this is a valid
+indexing but an invalid function call: `A(:)`. However I don't distinguish at
+all and say that all of them are `function_call`.
+
+- Function definitions, when inside a class, accepts a special syntax for the
+name of the function, allowing it to be preceded by either `get.` or `set.`,
+like `function get.name()`. I could have a `method_definition` that would allow
+that to only be valid in the class context, but I doubt that would be worth it.
+So any function anywhere can have those and be recognize as correct still.
+Given the existence of external method definition, maybe that is even the
+correct thing to do, since we don't know if the current file is inside a
+special class folder.
+
+# Installation
+
+This parser is now the default for the following editors:
+
+- Emacs: Through the `tree-sitter-langs` package.
+- Helix: Builtin, now in master and will be available in the next release (whatever comes after 23.05).
+- Neovim: Through the `nvim-treesitter` plugin.
+
+# Screenshots
+
+![First Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s1.png)
+![Second Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s2.png)
+![Third Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s3.png)

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab/__init__.py

@@ -0,0 +1,5 @@
+"Matlab grammar for tree-sitter"
+
+from ._binding import language
+
+__all__ = ["language"]

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab/__init__.pyi

@@ -0,0 +1 @@
+def language() -> int: ...

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab/binding.c

@@ -0,0 +1,27 @@
+#include <Python.h>
+
+typedef struct TSLanguage TSLanguage;
+
+TSLanguage *tree_sitter_matlab(void);
+
+static PyObject* _binding_language(PyObject *self, PyObject *args) {
+    return PyLong_FromVoidPtr(tree_sitter_matlab());
+}
+
+static PyMethodDef methods[] = {
+    {"language", _binding_language, METH_NOARGS,
+     "Get the tree-sitter language for this grammar."},
+    {NULL, NULL, 0, NULL}
+};
+
+static struct PyModuleDef module = {
+    .m_base = PyModuleDef_HEAD_INIT,
+    .m_name = "_binding",
+    .m_doc = NULL,
+    .m_size = -1,
+    .m_methods = methods
+};
+
+PyMODINIT_FUNC PyInit__binding(void) {
+    return PyModule_Create(&module);
+}

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: tree-sitter-matlab
+Version: 1.0.0
+Summary: Matlab grammar for tree-sitter
+License: MIT
+Project-URL: Homepage, https://github.com/tree-sitter/tree-sitter-matlab
+Keywords: incremental,parsing,tree-sitter,matlab
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: core
+Requires-Dist: tree-sitter~=0.21; extra == "core"
+
+# MATLAB grammar for tree-sitter.
+
+There are screenshots at the end of this README :)
+
+This parser has the objective of generating a tree that is as correct as
+possible (but sometimes just convenient) with what MATLAB itself executes. It
+is not intended only for syntax highlight, but also to be used by scripts to
+whatever it may be needed. In fact, I wrote it because I'm a Neovim/Doom Emacs
+user and love having text-objects, and was really missing a text object for
+matrices rows/cells.
+
+Being as correct as possible means that some things are done correctly, for
+example:
+
+- Commands are parsed the same way MATLAB does it, by treating arguments as
+literals, grouping them correctly and only starting comments when allowed. It
+should perfectly match what MATLAB does.
+
+- Assignment has its own token, and multiple-variable assignment is NOT an
+assignment to a matrix (and returning an error is the correct thing to do, as
+it allows the user to see that something is off with the highlight, meaning
+something is probably off with the code):
+
+```matlab
+% (assignment (multioutput_variable (identifier) (identifier)) (identifier)) 
+[a,b] = d
+
+% this is WRONG:
+[a;b] = d
+```
+
+- Inside a matrix, `1 + 1` and `1 +1` are different things:
+
+```matlab
+a = 1 + 1 % 2
+a = 1 +1 %2
+[1 + 1] == [2]
+[1 +1]  == [1 1]
+```
+
+Being convenient means that sometimes the difference between what is acceptable
+and what is not acceptable lives in the semantics, so we can't know. In such
+cases I just accept semantically wrong but syntax correct things and group them
+in the same token (first example). I do the same when the overhead of
+generating a specific token would not really pay off (second example).
+
+- Function calls and Matrix Indexing are the same in MATLAB: `A(1)` can be any
+of them and you cannot tell them apart unless you know for sure what `A` is
+referring to. So for convenience I just generate a `function_call` for them and
+also for cell indexing `A{1}`. The "problem" with that is that this is a valid
+indexing but an invalid function call: `A(:)`. However I don't distinguish at
+all and say that all of them are `function_call`.
+
+- Function definitions, when inside a class, accepts a special syntax for the
+name of the function, allowing it to be preceded by either `get.` or `set.`,
+like `function get.name()`. I could have a `method_definition` that would allow
+that to only be valid in the class context, but I doubt that would be worth it.
+So any function anywhere can have those and be recognize as correct still.
+Given the existence of external method definition, maybe that is even the
+correct thing to do, since we don't know if the current file is inside a
+special class folder.
+
+# Installation
+
+This parser is now the default for the following editors:
+
+- Emacs: Through the `tree-sitter-langs` package.
+- Helix: Builtin, now in master and will be available in the next release (whatever comes after 23.05).
+- Neovim: Through the `nvim-treesitter` plugin.
+
+# Screenshots
+
+![First Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s1.png)
+![Second Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s2.png)
+![Third Screenshot](https://raw.githubusercontent.com/acristoffers/tree-sitter-matlab/screenshots/s3.png)

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+bindings/python/tree_sitter_matlab/__init__.py
+bindings/python/tree_sitter_matlab/__init__.pyi
+bindings/python/tree_sitter_matlab/binding.c
+bindings/python/tree_sitter_matlab/py.typed
+bindings/python/tree_sitter_matlab.egg-info/PKG-INFO
+bindings/python/tree_sitter_matlab.egg-info/SOURCES.txt
+bindings/python/tree_sitter_matlab.egg-info/dependency_links.txt
+bindings/python/tree_sitter_matlab.egg-info/not-zip-safe
+bindings/python/tree_sitter_matlab.egg-info/requires.txt
+bindings/python/tree_sitter_matlab.egg-info/top_level.txt
+src/parser.c
+src/scanner.c

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[core]
+tree-sitter~=0.21

tree_sitter_matlab-1.0.0/bindings/python/tree_sitter_matlab.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+_binding
+tree_sitter_matlab

tree_sitter_matlab-1.0.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tree-sitter-matlab"
+description = "Matlab grammar for tree-sitter"
+version = "1.0.0"
+keywords = ["incremental", "parsing", "tree-sitter", "matlab"]
+classifiers = [
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Topic :: Software Development :: Compilers",
+  "Topic :: Text Processing :: Linguistic",
+  "Typing :: Typed"
+]
+requires-python = ">=3.8"
+license.text = "MIT"
+readme = "README.md"
+
+[project.urls]
+Homepage = "https://github.com/tree-sitter/tree-sitter-matlab"
+
+[project.optional-dependencies]
+core = ["tree-sitter~=0.21"]
+
+[tool.cibuildwheel]
+build = "cp38-*"
+build-frontend = "build"

tree_sitter_matlab-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tree_sitter_matlab-1.0.0/setup.py

@@ -0,0 +1,60 @@
+from os.path import isdir, join
+from platform import system
+
+from setuptools import Extension, find_packages, setup
+from setuptools.command.build import build
+from wheel.bdist_wheel import bdist_wheel
+
+
+class Build(build):
+    def run(self):
+        if isdir("queries"):
+            dest = join(self.build_lib, "tree_sitter_matlab", "queries")
+            self.copy_tree("queries", dest)
+        super().run()
+
+
+class BdistWheel(bdist_wheel):
+    def get_tag(self):
+        python, abi, platform = super().get_tag()
+        if python.startswith("cp"):
+            python, abi = "cp38", "abi3"
+        return python, abi, platform
+
+
+setup(
+    packages=find_packages("bindings/python"),
+    package_dir={"": "bindings/python"},
+    package_data={
+        "tree_sitter_matlab": ["*.pyi", "py.typed"],
+        "tree_sitter_matlab.queries": ["*.scm"],
+    },
+    ext_package="tree_sitter_matlab",
+    ext_modules=[
+        Extension(
+            name="_binding",
+            sources=[
+                "bindings/python/tree_sitter_matlab/binding.c",
+                "src/parser.c",
+                "src/scanner.c"
+            ],
+            extra_compile_args=[
+                "-std=c11",
+            ] if system() != "Windows" else [
+                "/std:c11",
+                "/utf-8",
+            ],
+            define_macros=[
+                ("Py_LIMITED_API", "0x03080000"),
+                ("PY_SSIZE_T_CLEAN", None)
+            ],
+            include_dirs=["src"],
+            py_limited_api=True,
+        )
+    ],
+    cmdclass={
+        "build": Build,
+        "bdist_wheel": BdistWheel
+    },
+    zip_safe=False
+)